Skip to content

docs(user-docs): detailed review against dev — browser admin claim, first-run overlay, platform keys, canvas lifecycle, abilities 2.0 - #2803

Merged
vybe merged 1 commit into
devfrom
docs/user-docs-review-2026-09-14
Sep 15, 2026
Merged

vybe merged 1 commit into
devfrom
docs/user-docs-review-2026-09-14

Conversation

@trinity-ability

Copy link
Copy Markdown
Contributor

Summary

A detailed review of every page under docs/user-docs/ against the code on dev, 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

Corrections found by the audit

  • Permissions tab direction was documented backwards (it controls who this agent may call).
  • subscribe_to_event third argument is target_message; initialize_github_sync takes repo_owner/repo_name, not repo_url.
  • Image generation endpoint is /api/images/generate; health check is /health.
  • /api/internal/decrypt-and-inject and the process-trigger routes no longer exist; the startup credential auto-import was documented as working (see follow-ups).
  • Slack / Nevermined / Telegram / WhatsApp setup steps and Settings labels now match the UI; GitHub token locations corrected; MCP key panel labels and revoke-vs-delete.
  • New sections: per-public-link Connect Slack, the Workspace Speak replies aloud toggle, webhook rate limits, the missing git-sync and canvas routes, Failed execution stat card, High Ctx mobile label, no "tag clouds" / "Require verified email" toggle / "Operations → Restart All" (none exist).

Not in this PR

  • No whats-new/v0.9.5.md — the release is still at RC; /release writes docs/releases/0.9.5.md at cut time, and the screenshot request follows then.

Follow-ups for code owners (not docs)

  • docker/base-image/startup.sh still POSTs to /api/internal/decrypt-and-inject, which no router serves — every such boot logs "Could not auto-import credentials".
  • Operations has no per-item Cancel, yet cancelling is now the intended action for the legacy skills-library alert (fix(skills): the legacy-adoption refusal files one row per refused URL, not one per sync (#2744) #2777).
  • src/mcp-server/src/tools/rooms.ts create_room descriptions say 60 messages / 24 h; the service defaults are 200 / 168 h.
  • trinity-ops-public scripts/tunnel.sh port defaults disagree with its own .env.example.
  • abilities README.md and marketplace.json lag the plugins on disk.

Verification

  • find docs/user-docs -name '*.md' | wc -l → 139; 78 modified (+790 / −456)
  • Relative-link check across the tree → 0 broken; FAQ index anchors → 0 bad
  • Issue-number / codename grep → 0 hits outside dev-announcements/ and whats-new/ archives; FAQ grep → 0
  • Public-safety greps (sshpass|tailnet|ts.net|ssh -i …@, private IPs, instances/*/) → 0 hits tree-wide
  • enterprise-docs-guard.yml pattern run locally over docs/user-docs/ → 0 hits
  • UI labels taken from the .vue files, endpoints from router decorators, MCP tool signatures from the .ts modules

Journey 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

…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>

@vybe vybe left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

merge-train: batch validated on train/20260915-1011 (#2808) — full suite green across all five members together.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type-docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants