docs: enrich CLAUDE.md and remove unused scaffold

[NeverMore93]

Summary

• Enriched CLAUDE.md with accurate key constraints (recursion guard, gRPC-only traces, session Map vs AsyncLocalStorage, inactive-when-unconfigured, version-first change policy)
• Added missing env vars to config table (OTEL_EXPORTER_OTLP_HEADERS, signal-specific timeouts, OTEL_PLUGIN_CONFIG_PATH, OTEL_MAX_LINE_LENGTH)
• Added timeout and service.name precedence chains
• Added testing patterns section documenting test helper conventions
• Removed unused index.ts scaffold file (Bun init artifact)
• Removed redundant (no AsyncLocalStorage) from Architecture tree (Key Constraints owns this)
• Collapsed verbose testing patterns to one sentence

Summary by CodeRabbit

• Documentation

  • Enhanced project documentation with architecture overview, configuration guidance, and testing structure details.

• Chores

  • Removed debug logging from initialization code.

[coderabbitai]

Warning

Rate limit exceeded

@NeverMore93 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 38 seconds before requesting another review.

To continue reviewing without waiting, purchase usage credits in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9ce16358-5464-4384-ad18-fd265e87ea7e

📥 Commits

Reviewing files that changed from the base of the PR and between 91a9876 and e5fb821.

📒 Files selected for processing (1)

• CLAUDE.md

📝 Walkthrough

Walkthrough

Documentation updates to CLAUDE.md reorganize sections including project overview, architecture, test structure, and configuration details with expanded OTEL environment variable documentation. A debug console.log is removed from index.ts.

Changes

Documentation & Configuration

Layer / File(s)	Summary
Project Overview & Architecture CLAUDE.md (lines 3–42)	Added introductory content with commands, build/test instructions, architecture overview, data flow description, and tests section detailing layout and conventions.
Configuration Documentation CLAUDE.md (lines 139–153)	Expanded configuration notes with OTEL-related environment variables (protocols, timeouts, headers), config file path handling, and precedence rules for timeout and service name.
Scope & Constraints CLAUDE.md (lines 107–129)	Introduced "What This Project Is" section defining project scope, context, constraints, and key runtime/protocol/versioning behaviors; removed prior Behavioral Guidelines block.

Code Cleanup

Layer / File(s)	Summary
Debug Statement Removal index.ts	Removed top-level console.log("Hello via Bun!") statement.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• NeverMore93/opencode-otel#21: Also modifies CLAUDE.md documentation structure and content.

Poem

🐰 Hoppity-hop, let's clean and write,
Our docs now shine, the config's right,
A stray log goes, the codebase freed,
With architecture clear indeed! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes both main changes: enriching CLAUDE.md documentation and removing the unused index.ts scaffold file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/improve-claude-md

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[NeverMore93]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[gemini-code-assist]

Code Review

This pull request significantly expands the CLAUDE.md documentation, adding detailed sections on commands, architecture, data flow, and configuration. It also introduces a 'Version-first change policy' and removes a boilerplate file. Review feedback suggests clarifying the protocol support documentation to distinguish between logs and traces and points out that the PR itself currently violates the newly established version-bump policy.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

CLAUDE.md (1)

126-126: ⚖️ Poor tradeoff

Consider documenting the session interleaving limitation in user-facing docs.

The constraint that concurrent session interleaving can mis-tag logs is documented in CLAUDE.md but not in README.md or tracked as a known issue. For single-agent deployments (typical use case), this has minimal real-world impact, but consider whether this limitation warrants a note in the README if multi-session scenarios are supported.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@CLAUDE.md` at line 126, Add the documented session interleaving limitation
from CLAUDE.md into user-facing docs by adding a short note to README.md (and/or
a "Known issues" or "Limitations" section) that explains that session tracking
currently uses a module-level variable activeSessionId rather than
AsyncLocalStorage and can cause mis-tagged logs under concurrent multi-session
deployments; mention recommended scope (single-agent deployments) and link or
reference CLAUDE.md for full details so consumers are aware of the limitation
and where to find more context.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@CLAUDE.md`:
- Line 23: Add a short definition of the "BAT" acronym and a one-line
description of "BAT resource resolution" to the documentation: update the
CLAUDE.md "BAT / Captain Example" section (or add a glossary entry) to expand
"BAT" (what the letters stand for) and briefly explain how BAT resource
resolution works and why it’s used; ensure the text references usages found in
Provider (src/provider.ts), provider tests, config and specs so readers can
connect the term to the code.

---

Nitpick comments:
In `@CLAUDE.md`:
- Line 126: Add the documented session interleaving limitation from CLAUDE.md
into user-facing docs by adding a short note to README.md (and/or a "Known
issues" or "Limitations" section) that explains that session tracking currently
uses a module-level variable activeSessionId rather than AsyncLocalStorage and
can cause mis-tagged logs under concurrent multi-session deployments; mention
recommended scope (single-agent deployments) and link or reference CLAUDE.md for
full details so consumers are aware of the limitation and where to find more
context.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9a82fec3-7836-42a7-817a-6eb81d6d11bb

📥 Commits

Reviewing files that changed from the base of the PR and between 4744e4a and 91a9876.

📒 Files selected for processing (2)

• CLAUDE.md
• index.ts

💤 Files with no reviewable changes (1)

• index.ts