docs: restructure user nav into groups; move dev docs to repo#449
Open
jamesvillarrubia wants to merge 2 commits into
Open
docs: restructure user nav into groups; move dev docs to repo#449jamesvillarrubia wants to merge 2 commits into
jamesvillarrubia wants to merge 2 commits into
Conversation
The docs site is the product manual for people USING Pipecraft. Flatten-list of 18 items -> 5 intent-based groups (Get started / Guides / Reference / Understand / Help), and remove developer/internal material from the user nav. User nav: - Get started: Introduction, Quickstart (recast cli-reference — 0 inbound links) - Guides: Workflow generation, Workflow patterns, Versioning, Examples - Reference: CLI reference (was Commands), Configuration, Action modes - Understand: Architecture (kept — it's user-facing) - Help: Troubleshooting, Error reference (de-prefixed), FAQ, Roadmap, Security Developer/internal -> repo (linked from README): - testing-guide.md -> docs-dev/testing.md - ast-operations.md -> docs-dev/ast-operations.md (internals) - contributing.md removed (CONTRIBUTING.md already exists at root) - removed orphan docs-index.md / readme.md (README is canonical) - API Reference (generated typedoc) dropped from the nav; pages kept so the ~11 inbound cross-links still resolve (fully relocating generated output is a follow-up) Sidebar uses custom labels so heavily-linked file ids (commands x16, api x11) are unchanged — no broken links. docs build passes; the 2 real broken links from the moves (faq->contributing, error-reference->testing) repointed. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- init is non-interactive by default (--interactive opts into the wizard); drop the stale package-manager auto-detection prompts (packageManager is deprecated) - add the missing 'pipecraft setup' step (creates the branch flow on the remote) — its absence is why promotions fail with 'Base ref must be a branch' - clarify setup (branches) vs setup-github (permissions); fix example step numbering - minimal config example: add required mergeStrategy/requireConventionalCommits/semver and use prefixes instead of deprecated testable/deployable 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.
Restructure the user docs navigation
The docs site is the product manual for people using Pipecraft, so the menu now contains only user-facing pages, grouped by intent. Developer/internal material moves to the repo (linked from the README).
Before → after
Flat list of 18 → 5 groups:
Clarity fixes
commandsis now the CLI reference (Reference group); the task walkthroughcli-referencebecomes Quickstart (Get started). No content lost; clear distinct roles.PipeCrafttitle prefix (e.g. "PipeCraft Error Handling Guide" → "Error reference").Developer docs → repo (out of the user site)
testing-guide.md→docs-dev/testing.mdast-operations.md→docs-dev/ast-operations.md(generator internals)contributing.mdremoved (rootCONTRIBUTING.mdalready exists)docs-index.md/readme.md(README is canonical)docs-dev/.Safety
Sidebar uses custom labels, so heavily cross-linked file ids (
commands×16,api×11) are unchanged → no broken links.pnpm docs:buildpasses; the 2 genuinely broken links from the moves (faq→contributing, error-reference→testing) were repointed.🤖 Generated with Claude Code