docs: consolidate Web console and package docs - #262
Merged
Merged
Conversation
Merge docs/web/architecture.md and core-connection.md into console-server.md, rename protocol-coverage.md to console-api-usage.md and fix its stale rows, rewrite the operator console guide, and delete the roadmap, the metrics requirement proposals and the old overview image. Repoint inbound links and regenerate the docs site.
Reduce apps/web/README.md to the web-developer guide (rules, local run with the fixture console, checks including Playwright, screenshots). Fix PRODUCT.md, DESIGN.md and the impeccable surface against the shipped console and its stylesheets, and correct the i18n, Magic UI and standard-size notes.
Document the TypeScript client and fold the saved-default examples into the agents-client README; replace public admission rules in the Claude adapter README with links to their contracts and fold in SUBAGENTS.md; remove stale sandbox claims from the MiniMax Code bridge guide.
Put every paragraph, list item and blockquote of the Markdown files PR4 owns on one line (unwrap_md.py; render_equal.mjs reports identical rendering) and regenerate the docs site. The impeccable surface keeps its one-field-per-line format; files edited only for link fixes stay wrapped for their owners.
Correct console-server, console API usage, the operator guide and the apps/web README against the code; fix DESIGN.md tokens, component facts and the topology liveness rule; regenerate the impeccable sidecar from DESIGN.md and the stylesheets; correct the MiniMax Code bridge and Claude subagent notes; and regenerate the docs site.
Point the console guide and console server doc at the domain setup, reverse proxy and sandbox configuration sections that the operator guide rebuild moved, and regenerate the docs site.
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
1 participant
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.
Part of the documentation overhaul: one owner per subject, grouped content, plain tone, no historical copies, no hard wraps.
Changes
docs/web/README.mdis the single operator guide to the console.docs/web/console-server.mdmergesdocs/web/architecture.mdandcore-connection.md. It covers the request boundary, forwarding rules, settings, sign-in, domain setup and verification.docs/web/protocol-coverage.mdbecomesconsole-api-usage.md: which Core routes each console page uses, and the read bounds.docs/web/roadmap.md,admin-metrics-backend-requirements.md,core-process-metrics-requirements.mdand the old console screenshot.apps/web/README.mdis a web-developer package guide only. PRODUCT.md, DESIGN.md, the impeccable surface,design.json, the i18n README and standard-sizes.md are fact-checked against the code and stylesheets.packages/agents-client/README.mddocuments the TypeScript client and the Go client, and absorbssaved-agent-defaults.md.SUBAGENTS.md.Stale claims fixed
sandbox_admin.system.cssandfoundation.css.Verification
make check-names,make check-docs,make check-distributionNeed help on this PR? Tag
@codesmith-botwith what you need. Autofix is disabled.