Skip to content

docs: complete the getting-started flow + workspace-driven routing - #166

Merged
its-mash merged 3 commits into
mainfrom
docs/enrich-getting-started-flow
Jun 15, 2026
Merged

docs: complete the getting-started flow + workspace-driven routing#166
its-mash merged 3 commits into
mainfrom
docs/enrich-getting-started-flow

Conversation

@its-mash

Copy link
Copy Markdown
Member

The getting-started guide stopped at "connect your client" and several docs still described the removed Follow-Active / per-client-grant model. This brings the guide docs in line with how McpMux actually works today (workspace-root routing, dropped in migration 005's client_pin removal).

getting-started — now end to end

Adds the missing post-connection steps so the journey is complete:

  • Step 6 — Approve the connection: the one-click OAuth approval when an app first connects.
  • Step 7 — Route the folder to the right tools: tools are decided by the folder the client opens (Workspace binding → Space + FeatureSet); unmapped folders fall back to the active Space.
  • Step 8 — @mux Tool Optimization: let the AI compose + pin a focused toolset from chat.
  • Tightened earlier steps and refreshed Next Steps with Workspaces + Tool Optimization.

clients — current model

Replaced "Connection Modes" (Follow Active / Locked / Ask on Change) and per-client FeatureSet grants with: one-click OAuth approval, workspace-driven routing (same folder → same tools, regardless of app), access keys, and managing/revoking apps.

spaces / gateway / index

  • Removed remaining Follow-Active references; the active Space is now the fallback for unmapped folders.
  • gateway request flow updated to resolve by workspace root.
  • index Key Concepts now includes Workspaces and Tool Optimization.

Validation

Built discover.ui against these docs → 164 pages, every cross-link and screenshot resolves (screenshots are live from #25). No prose-only tsc/lint gates, but the pre-commit hook (fmt/clippy/eslint/typecheck) passed.

Renders on mcpmux.com/docs once merged (the site sources docs/guide/ via fetch-docs).

its-mash added 3 commits June 15, 2026 14:28
…ting

The getting-started guide stopped at "connect your client" and several
docs still described the removed Follow-Active / per-client-grant model.

- getting-started: add the missing steps — connection approval, folder →
  Space/FeatureSet routing (Workspaces), and @mux Tool Optimization — so
  the guide covers the full journey end to end.
- clients: replace the obsolete "connection modes" and per-client grants
  with the current model — one-click OAuth approval + workspace-driven
  routing (tools decided by the folder the app reports, not the app).
- spaces / gateway / index: fix the remaining Follow-Active references; the
  active Space is now the fallback for unmapped folders. Add Workspaces and
  Tool Optimization to the index Key Concepts.

Validated by building discover.ui against these docs (164 pages, all
cross-links and screenshots resolve).

Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
Several guide pages were text-heavy with no visuals. Add a relevant app
screenshot to each dry section:

- security: the consent dialog in the OAuth Security section
- gateway: the Settings page (gateway port, startup, updates) in Starting
  and Stopping
- workspaces: the FeatureSet detail showing the toolset a folder resolves to
- feature-sets: the effective-features view; also reframe the stale
  "assign per client" note to workspace-driven routing

Validated by building discover.ui against the docs (164 pages, every image
resolves from the live screenshots).

Signed-off-by: Mohammod Al Amin Ashik <maa.ashik00@gmail.com>
@its-mash
its-mash merged commit 92f8ac2 into main Jun 15, 2026
1 check passed
@its-mash
its-mash deleted the docs/enrich-getting-started-flow branch June 15, 2026 06:49
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.

1 participant