Skip to content

docs(mintlify): beginner-first overhaul for v1.7.1 (#56)#59

Merged
richard-devbot merged 1 commit into
mainfrom
docs/mintlify-overhaul-56
Jun 2, 2026
Merged

docs(mintlify): beginner-first overhaul for v1.7.1 (#56)#59
richard-devbot merged 1 commit into
mainfrom
docs/mintlify-overhaul-56

Conversation

@richard-devbot
Copy link
Copy Markdown
Owner

Closes #56.

Rewrites the Mintlify docs to match the v1.7.1 codebase and guide a brand-new user step by step.

New pages

  • getting-started/install-your-framework — install the agent framework first (Pi, Claude Code, Codex CLI, Gemini CLI, Operator, universal), then add RStack. Honest integration-depth table (🟢 native vs 🟡 asset-based).
  • reference/business-hub — the :3008 dashboard, Studio & Studio 3D, artifact browser, scope switcher, multi-project aggregation. States the token/cost limitation plainly.
  • reference/webhooks — all 5 channels + both config options + notify --test.
  • reference/approvalspolicy.json, manager allow-list, RSTACK_APPROVAL_TOKEN.

Stale → real

  • Removed commands that don't exist (list prompts, info); cli.mdx rebuilt around the real commands (init/hub/notify/list/add/validate) + dashboard binaries
  • Quickstart & installation now lead with npm install rstack-agents + rstack-agents init
  • Port 3005 → 3008 everywhere; '14 pipeline agents' → 15
  • configuration.mdx gained identity/hub/approval/notification env vars; governance gained policy/token
  • docs.json: new Business Hub nav group, install-your-framework, observability wired in
  • Removed a broken hero <img> (asset never existed)

Verification

  • mint broken-links: no broken links
  • docs.json valid; all 34 nav refs resolve
  • 106/106 repo tests pass, lint clean

Note: publishing to the hosted Mintlify project (evoke-f0bfabff) is a dashboard/GitHub-app action — see the PR's follow-up comment for exact steps.

🤖 Generated with Claude Code

… feature (#56)

New pages:
- getting-started/install-your-framework — step-by-step per framework
  (Pi, Claude Code, Codex, Gemini CLI, Operator, universal) with honest
  integration-depth table
- reference/business-hub — the :3008 dashboard, Studio 3D, artifact browser,
  scope switcher, multi-project aggregation (+ honest token/cost limitation)
- reference/webhooks — all 5 channels (slack/teams/discord/telegram/whatsapp),
  both config options, notify --test
- reference/approvals — policy.json, manager allow-list, RSTACK_APPROVAL_TOKEN

Fixes (stale → real):
- removed commands that don't exist (list prompts, info)
- cli.mdx rewritten around real commands (init/hub/notify/list/add/validate)
  + the dashboard binaries
- quickstart + installation now lead with 'npm install rstack-agents' + init
- port 3005 → 3008 (architecture, observability, pi-tools)
- '14 pipeline agents' → 15 (intro, sdlc-pipeline/overview)
- configuration.mdx: identity/hub/approval/notification env vars added
- governance: policy.json + token + manager roles
- docs.json: new Business Hub group, install-your-framework, observability in nav
- removed broken hero <img> (asset never existed) — mint broken-links clean

Closes #56

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@qodo-code-review
Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@richard-devbot richard-devbot merged commit 1dc7e5f into main Jun 2, 2026
4 checks passed
@richard-devbot richard-devbot deleted the docs/mintlify-overhaul-56 branch June 2, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation overhaul: step-by-step Mintlify docs for every framework (Pi, Claude Code, Codex, Gemini CLI, Operator, custom)

2 participants