docs: fix audit documentation issues (#28, #34-37, #46, #56-59, #72)

[nficano]

Summary

• Fixes WebSocket bearer-token examples do not authenticate the ARCP session #28 — clarify WebSocket bearer vs ARCP session auth; warn about defaults/auth.scheme = "none".
• Fixes Json.fs doc says InternalTag but code uses ExternalTag #34 — Json.fs module doc describes WithUnionExternalTag() wire shape.
• Fixes Errors.fs doc claims only three non-retryable cases #35, Errors.fs SdkError carries a doc block describing the exception #36, Comment & doc grammar/tone batched for Errors.fs #46 — Errors.fs retryability and deduped doc blocks.
• Fixes Capabilities.fs AgentInventory carries two contradictory doc blocks #37 — remove duplicate AgentInventory doc block.
• Fixes JobManager.EmitEventAsync XML doc claims it updates LastEventSeq #56 — JobManager.EmitEventAsync doc delegates LastEventSeq to outbox.
• Fixes Grammar/tone batch: historical asides and informal register in comments #57 — tone cleanup in JobSubmitFlow and ArcpServer comments.
• Fixes JobHandle.Events doc says non-result_chunk but impl forwards ResultChunk #58 — filter ResultChunk from Events channel (chunks via TryReadResultBytes).
• Fixes JobHandle doc references nonexistent ResultBytes member #59 — JobHandle doc references TryReadResultBytes.
• Fixes Comments/typos batch — ArcpClient.fs #72 — ArcpClient chunk error comment accuracy.

Test plan

• dotnet build
• dotnet test — 296 passed

Made with Cursor

[coderabbitai]

Warning

Review limit reached

@nficano, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 9 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, 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 include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 77e5d947-2bc4-4055-9402-644504196066

📥 Commits

Reviewing files that changed from the base of the PR and between 348e6f5 and 75e1cd0.

📒 Files selected for processing (12)

• docs/getting-started.md
• docs/transports.md
• src/Arcp.Client/ArcpClient.fs
• src/Arcp.Client/JobHandle.fs
• src/Arcp.Client/Transport/WebSocket.fs
• src/Arcp.Core/Capabilities.fs
• src/Arcp.Core/Errors.fs
• src/Arcp.Core/Json.fs
• src/Arcp.Runtime/ArcpServer.fs
• src/Arcp.Runtime/Internal/JobSubmitFlow.fs
• src/Arcp.Runtime/JobManager.fs
• tests/Arcp.IntegrationTests/JobLifecycleTests.fs

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/docs-audit-issues

---

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.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!