docs: reframe getting-started around the AI build/verify loop#2666
Merged
Conversation
feat(studio): per-object API / Hooks / Actions tabs + Data-pillar polish (#2330) objectui@c27bd3264f394bec5f5f71326118bfb115fbe884
Center the docs on the actual ObjectStack workflow: an AI agent (Claude Code) authors typed metadata, a validation gate catches silent-at-runtime mistakes, the human verifies in the visual Console, and the built app is itself AI-operable over MCP. - New flagship tutorial "Build with Claude Code" — the whole loop on a live-built Support Desk app, grounded in real `os` CLI output. - New concept page "How AI Development Works" — why the loop is fast and safe (skills+AGENTS.md, os validate, contract-first, draft-gating, worktree). - Repurpose the old hand-authoring Quick Start into "Anatomy of an ObjectStack App" (read-to-verify); keep the /quick-start slug so inbound links survive. - Front-load the "your app is an MCP server" story: env-var value-prop, a dedicated api/index section + request-path diagram, deployment pointer. - Reframe by real development layering (Data / Automation / Interface / Access / AI) instead of the ObjectQL/ObjectOS/ObjectUI protocol trinity. - Add Mermaid diagrams (build loop, AI architecture, protocol stack, MCP request path) using the site's existing Mermaid support. - Docs-site chrome: drop the meaningless "Documentation" self-link, fix the UI Engine icon (deprecated `Layout` -> `LayoutDashboard`), hide the single-language switcher. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
17 tasks
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.
What & why
The docs said ObjectStack is "AI-native" but the getting-started track still read as "a human hand-writes TypeScript metadata." This PR makes the actual workflow the spine of the docs: an AI agent (Claude Code) authors the typed metadata → a validation gate catches mistakes that fail silently at runtime → the human verifies in the visual Console → iterate → the built app is itself AI-operable over MCP.
Changes
New pages (Get Started)
os validateerror are grounded in real local CLI output (not fabricated).os validate, contract-first, draft-gating, worktree isolation).Reframes
/quick-startkept, so inbound links/SEO survive.ai/index+cli+examplesreframed around the loop;ai/indexgets a two-axes signpost (AI builds the app vs the app exposes AI).api/indexsection + request-path diagram, a deployment pointer.Diagrams — added Mermaid (build loop, AI architecture, protocol stack, MCP request path) using the site's existing Mermaid support.
Docs-site chrome — removed the meaningless "Documentation" self-link, fixed the UI Engine sidebar icon (deprecated
Layout→LayoutDashboard), hid the single-language switcher.Verification
Ran the docs site (
apps/docs) and checked every changed page in the browser: all pages return 200 with zero MDX/Mermaid compile errors, nav order is correct, new anchors (#your-app-as-an-mcp-server,#mcp-server,#what-you-build) resolve, and all four Mermaid diagrams render as themed SVG. Sidebar chrome fixes verified via DOM inspection + screenshot.🤖 Generated with Claude Code