docs(user-docs): detailed review against dev — browser admin claim, first-run overlay, platform keys, canvas lifecycle, abilities 2.0 - #2803
Merged
Conversation
…admin claim, first-run overlay, platform keys, canvas lifecycle, abilities 2.0 Every page under docs/user-docs/ was audited against the routers, views, feature flows and today's merges. 78 pages updated, 61 verified unchanged; FAQ 431 → 470 questions with the index regenerated from headings. Landed since the morning sync and now documented: - browser admin claim on 1-Click / installer installs (no generated password, claim at /setup, ADMIN_PASSWORD_SOURCE=browser) and the one first-run overlay that replaces the dashboard card ladder, with its re-run entry; "restart the backend" corrected to a container recreate wherever .env must be re-read - platform keys (Claude, GitHub, Resend, Gemini) set and validated in Settings, env vars as the fallback, across credentials / voice / VoIP / image / avatars - canvas lifecycle: delete, Manage, pin, search, the per-agent cap, share links, PDF, open canvas as turn context, the two-fact header; full REST + MCP surface - abilities marketplace 2.0: retired domain wizards removed everywhere, plugin versions and skill counts corrected, TRINITY_PLATFORM_PLUGINS opt-out Corrections found by the audit: the Permissions tab direction was reversed; subscribe_to_event and initialize_github_sync signatures were wrong; the image generation endpoint path was wrong; two removed routes (decrypt-and-inject, process triggers) were still listed and the startup auto-import documented as working; Slack / Nevermined / Telegram / WhatsApp setup steps and Settings labels now match the UI; per-public-link Connect Slack, the Workspace speaker toggle, webhook rate limits and the skills-library legacy-adoption behaviour are new sections. Verification: relative-link check 0 broken (FAQ index anchors included); issue-number / codename grep 0 hits outside the historical archives; public-safety greps and the enterprise-docs-guard pattern 0 hits. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
3 tasks
10 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
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.
Summary
A detailed review of every page under
docs/user-docs/against the code ondev, following this morning's full sync (#2746). Everything that merged after that sync is now documented, and the audit also caught claims that had drifted earlier. 78 pages updated, 61 verified unchanged; FAQ 431 → 470 questions, index regenerated from headings.Landed since the morning sync, now documented
/setup(ADMIN_PASSWORD_SOURCE=browser). The dashboard card ladder is replaced by one first-run sequence with its re-run entry under Settings → General. Setup, quick start, overview, roles, the UI tour, all seven deploy guides, telemetry and the FAQ rewritten around it. Every "restart the backend to re-read.env" instruction corrected to a container recreate.f84bbce, today) — the eight retired domain wizards removed everywhere; plugin versions, skill counts,/trinity:*skill changes and theTRINITY_PLATFORM_PLUGINS=0opt-out.Corrections found by the audit
subscribe_to_eventthird argument istarget_message;initialize_github_synctakesrepo_owner/repo_name, notrepo_url./api/images/generate; health check is/health./api/internal/decrypt-and-injectand the process-trigger routes no longer exist; the startup credential auto-import was documented as working (see follow-ups).Failedexecution stat card,High Ctxmobile label, no "tag clouds" / "Require verified email" toggle / "Operations → Restart All" (none exist).Not in this PR
whats-new/v0.9.5.md— the release is still at RC;/releasewritesdocs/releases/0.9.5.mdat cut time, and the screenshot request follows then.Follow-ups for code owners (not docs)
docker/base-image/startup.shstill POSTs to/api/internal/decrypt-and-inject, which no router serves — every such boot logs "Could not auto-import credentials".src/mcp-server/src/tools/rooms.tscreate_roomdescriptions say 60 messages / 24 h; the service defaults are 200 / 168 h.scripts/tunnel.shport defaults disagree with its own.env.example.README.mdandmarketplace.jsonlag the plugins on disk.Verification
find docs/user-docs -name '*.md' | wc -l→ 139; 78 modified (+790 / −456)dev-announcements/andwhats-new/archives; FAQ grep → 0sshpass|tailnet|ts.net|ssh -i …@, private IPs,instances/*/) → 0 hits tree-wideenterprise-docs-guard.ymlpattern run locally overdocs/user-docs/→ 0 hits.vuefiles, endpoints from router decorators, MCP tool signatures from the.tsmodulesJourney Impact
Journey Impact: none: documentation only under docs/user-docs/ — no runtime code, no API or UI behaviour changes, no promise in tests/journeys/catalog.yaml touched.
🤖 Generated with Claude Code