docs(landing): add client pages and troubleshoot guide - #99
Conversation
|
✅ CI - Verify PASSED Commit:
|
|
Tools section is now four SOON stubs. CLI, Local API, Obsidian plugin and VS Code extension are slug-less Consequence: Dangling internal links removed: the "prefer an extension" pitch on the VS Code client page, and the CLI/Obsidian links in the troubleshoot sync-conflicts section. Verified locally: |
Obsidian plugin and VS Code extension pages under Tools, plus a real Troubleshoot page replacing the Resources stub. Cross-links the manual VS Code setup with the packaged extension.
Every sidebar group and nested parent gets a chevron toggle (button with aria-expanded). "Connect a client" and the "Tools" group start collapsed via a new defaultCollapsed flag on the nav data; everything else starts open. The group/parent holding the active route auto-expands, and the search filter renders as fully expanded so hidden children still match.
CLI, Local API, Obsidian plugin and VS Code extension become slug-less comingSoon entries and leave the registry, so /docs/cli, /docs/local-api, /docs/obsidian and /docs/vs-code-extension stop rendering (sitemap, llms and the .md mirrors follow the registry). Their content modules stay in the repo for revival. Drops the two internal links that would dangle: the VS Code extension pitch on the VS Code client page and the CLI/Obsidian links in the sync-conflicts section.
9792c68 to
1ba1fdf
Compare
1 participant
What
Three new docs pages, registered and placed in the restructured nav:
/docs/obsidian, Tools) - install Agentage Sync from the community store, sign in, choose a memory, sync. Covers the two-way git sync behavior, flagged conflicts, the desktop-only limitation, theExpose remote MCPsetting, and a short note on the separate Agentage Galaxy visualization plugin./docs/vs-code-extension, Tools) - the packaged alternative to the manual setup: it registers the cloud MCP server with the editor AI (VS Code, and Cursor / Windsurf / VSCodium via Open VSX), the editor runs the OAuth sign-in itself, and the extension stores no tokens. Includes the fallback command for older editors./docs/troubleshoot, Resources) - replaces thecomingSoonstub. Symptom-first: tools missing after a config change (restart the client), repeating sign-ins, wrong or empty memory, search finding nothing, sync conflicts, where to look and who to email.The existing
/docs/vs-codeclient page now cross-links the extension page and states the distinction (packaged vs manual, use one or the other).Why
The clients exist and are shipping, but the docs only described the manual MCP config. Troubleshooting was the biggest missing page: every support question so far is one of the cases above.
How
Three
DocPagedata modules underdocs/content/, wired intoregistry.tsandnav.ts, with sidebar icons added. Facts come from the clients' own manifests and READMEs (agentage/obsidian-sync,agentage/obsidian-galaxy,agentage/vscode-agentage); the troubleshoot page deliberately describes causes and checks rather than quoting error strings, since every client words them differently. Endpoint, auth origin, dashboard, and support-email values are pulled fromlib/mcp-docs.tsandlib/site.tsso they cannot drift.Verification
npm run verifygreen (type-check, lint, format, vitest 48/48, next build - now 50 static pages)./docs/obsidian,/docs/vs-code-extension,/docs/troubleshootall return 200, their.mdmirrors render, and the env-derived dashboard and support links resolve (the local build bakes the localhost dashboard origin, as the header does).