Conversation
Stand up a new, outward-facing "how to use mx" documentation site as its own VitePress app under apps/docs, themed to match the landing (teal accent, calm monochrome), and fold it into the same GitHub Pages deploy under /docs. This is distinct from the repo's docs/ folder, which stays as the internal contributor reference. Infra + seed content (Phase 1): - apps/docs: VitePress app (base /docs/), custom teal theme, local search, favicon, edit links. Seed pages: home, Why mx, Getting started, Core concepts. - deploy-landing.yml -> "Deploy site": builds the docs and copies them into apps/landing/dist/docs so one artifact serves / (landing), /deck, /docs. - Root scripts: docs:* now build the public site (apps/docs); the optional contributor-reference build moves to refdocs:*. Footer "Docs" link -> /docs. - Update CLAUDE.md / docs references to reflect the docs/ (contributor) vs apps/docs (public) split and the renamed scripts. Phase 2 (next): tutorial, per-feature guides, CLI reference, FAQ, restructure. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Flesh out the public user-docs site (apps/docs) into a complete guide: - Tutorial: end-to-end walkthrough (two features in parallel across two repos, ports, mission control, archive/resume). - Guides (one per feature): repos, works & worktrees, ports, hooks & hydration, context registry, mission control, archive & resume, coding agents. - Reference: user-facing CLI reference (every command by group) and a configuration page (runtime discovery, versioning, sync/update/migrate, files store). - FAQ. - Full nav + sidebar (Introduction / Tutorial / Guides / Reference); seed pages now link into the guides instead of "coming soon". - Convert the two raw-HTML blocks in the seed pages to VitePress containers so they render correctly under markdown.html=false. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add apps/docs/**, .gitignore, package.json, and pnpm-lock.yaml to the release workflow's paths-ignore so a docs-only or tooling-only merge to main doesn't trigger a release run that fails for lack of a version bump. A real release still bumps npm/package.json, which is not ignored. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Adds the public, user-facing documentation site at mx.rousanali.com/docs — a new VitePress app (
apps/docs), themed to match the landing, folded into the same GitHub Pages deploy. Deploy-only: no CLI/core change, no version bump (release workflow is path-ignored for this).What ships
apps/docs— VitePress site,base: /docs/, teal theme matching the landing, local search.deploy-landing.yml(now "Deploy site") builds the docs intoapps/landing/dist/docsso one artifact serves/(landing),/deck,/docs.docs:*scripts build the public site; the internal contributor-reference build moves torefdocs:*. Landing Footer "Docs" →/docs.release.ymlpath-ignore extended so docs/tooling merges don't trigger a release.The repo's
docs/folder stays as the internal contributor reference; this is the separate public site.