docs: sync guide/technical docs to the capability-aware bridge (LOT-018) - #30
Merged
Conversation
Update the remaining docs that still described the pre-LOT-018 model: - configuration (EN+FR): Bearer token + role model, dcs-tokens.yaml, no-key /config.json, ephemeral WS tickets; drop the obsolete "API key exposure" warning. - cli-reference (EN+FR): web client keeps the token server-side, hands tickets. - architecture/index (EN+FR): Bearer role-based auth (not X-API-Key), capability -aware actions. - README: fix the ASCII diagram (port 7777, role-based Bearer auth) and the MCP tool list (catalogue-driven). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Reviewer's GuideDocumentation-only PR that updates configuration, CLI, architecture, index, README, and changelog texts (EN/FR) to match the new capability-aware, role-based Bearer auth bridge, including the token-store configuration and the no-credential-in-browser web flow. Sequence diagram for the no-credential-in-browser web flowsequenceDiagram
actor Browser
participant dcs_client_web
participant dcs_serve
Browser->>dcs_client_web: GET /config.json
dcs_client_web-->>Browser: host, port
Browser->>dcs_client_web: POST /ws-ticket
dcs_client_web->>dcs_serve: POST /api/ws-ticket (Authorization: Bearer token)
dcs_serve-->>dcs_client_web: WebSocket ticket
dcs_client_web-->>Browser: WebSocket ticket
Browser->>dcs_serve: CONNECT /ws/stream?ticket=... (WebSocket)
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- In the configuration docs,
api_keyis now described as a durable Bearer token but the field name remainsapi_key; consider adding a brief inline note clarifying that the legacy field name is intentional to avoid confusion for existing users scanning the YAML examples. - The description of the WebSocket ticket flow is spread across configuration, CLI reference, and changelog; adding a short, centralized subsection that diagrams or summarizes the
GET /config.json+POST /ws-ticketinteraction could make the browser-no-credentials story easier to follow end-to-end.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the configuration docs, `api_key` is now described as a durable Bearer token but the field name remains `api_key`; consider adding a brief inline note clarifying that the legacy field name is intentional to avoid confusion for existing users scanning the YAML examples.
- The description of the WebSocket ticket flow is spread across configuration, CLI reference, and changelog; adding a short, centralized subsection that diagrams or summarizes the `GET /config.json` + `POST /ws-ticket` interaction could make the browser-no-credentials story easier to follow end-to-end.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation-only follow-up to the LOT-018 epic: several guide/technical pages still described the pre-epic model. Brings them in line with what shipped.
Changes
dcs-tokens.yaml(roles/levels),tokens_file;/config.jsonno longer serves a key and the browser only gets ephemeral WS tickets; replaced the now-obsolete "API key exposure" warning.dcs-client webkeeps the token server-side and hands the browser tickets via/ws-ticket.X-API-Key), capability-aware actions.7777, role-based Bearer auth) and the MCP tool list (catalogue-driven).No code changes. (This doc-only PR is mergeable thanks to LOT-019.)
🤖 Generated with Claude Code
Summary by Sourcery
Update user and technical documentation to reflect the capability-aware bridge with role-based Bearer authentication and the new token/ticket model.
Documentation:
dcs-tokens.yaml, and client token usage without exposing credentials in the browser.