docs: post-arc assessment fixes — reconcile front door, fix stale build/serve framing, add access-control/AG-UI/upgrading pages#346
Merged
Conversation
… (npm canonical), document sandbox/build config keys Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…pgrading page, K8s deploy home + nav
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
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.
Developer docs assessment → improvements
A docs assessment after the sandbox / Helm-charts / production-build-serve arc landed, plus lessons cross-referenced against a mature enterprise agent-ops product (CopilotKit Intelligence). The docs were already strong; the gaps were front-door consistency, staleness vs. what shipped, and discoverability of the production + access-control stories. Notably, several of Intelligence's own doc anti-patterns (contradictory README-vs-tutorial, copy-paste-breaking first commands) were exactly the issues found here — good corroboration.
Correctness (were wrong / stale)
dawn buildonly emitslanggraph.jsonfor LangSmith — now describes both default targets (node→server.mjs+ Dockerfile, run viadawn start;langsmith→langgraph.json).startfrom its own list — fixed.Front-door consistency
npm create dawn-ai-appentry point:npm run check,--port 2024). They previously taught different package managers, validation commands, and ports.Discoverability / structure (new pages)
/docs/access-control— ties the three layers into one mental model: tool scoping (which) / permissions (whether) / sandbox (what it can touch). Previously this framing lived only insidesandbox.mdx;mental-model.mdxnow points to it./docs/ag-ui— the AG-UI / CopilotKit web-UI story with a grounded event contract (RUN_STARTED,TEXT_MESSAGE_*,TOOL_CALL_*,STATE_SNAPSHOT,on_interrupt,RUN_FINISHED/ERROR— verified inpackages/ag-ui), and an honest callout that the SSE stream has no reconnect/replay guarantee (the code has none; not invented)./docs/upgrading— pre-1.0 fixed-group versioning + how to read changesets/releases (the FAQ pointed at release notes that had no home).deployment.mdx(audience-tagged, CNI note) so K8s deploy isn't buried under Execution Sandbox; bidirectional link added.configuration.mdxnow documents the shippedsandboxandbuildconfig keys; examples table gainsmemory+research.Follow-ups worth their own efforts (from the Intelligence scan — not in this PR)
code+docsPathper failure) so sandbox denials / HITL interrupts / tool-scope rejections become linkable docs.dawn doctorpreflight (Node/Docker/keys/config) with colored PASS/FAIL.AGENTS.mdwith a workspace map of all packages + a Definition of Done.Verified:
check-docspasses; the docs site builds with all three new routes statically generated and no broken links.🤖 Generated with Claude Code