docs: scaffold Guides section — step-by-step how-to catalog#34
Merged
Conversation
New top-level content/docs/guides/ section for end-to-end, task-oriented guides, distinct from the conceptual guide/ section. Adds the catalog index page, nav registration, LuCompass icon mapping, and a check-guides-docs.mjs validation script chained into pnpm build. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Scaffolds a new top-level Guides documentation section (content/docs/guides/) to host task-oriented, step-by-step walkthroughs distinct from the conceptual guide/ section, and adds CI-style validation to keep the new section consistent and link-complete.
Changes:
- Adds a new first-class
guidesnav section (meta + catalog page) and registers it in the top-level docs navigation. - Extends the Lucide icon mapping to support the new
LuCompassicon used by the Guides section. - Introduces
scripts/check-guides-docs.mjsand wires it intopnpm buildto enforce required pages, frontmatter, mentions, and cross-links.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-guides-docs.mjs | New validation script enforcing Guides section structure, required mentions, and cross-links. |
| package.json | Adds check:guides-docs and chains it into pnpm build. |
| lib/source.ts | Adds LuCompass → icons.Compass mapping for nav icon rendering. |
| content/docs/meta.json | Registers guides as a first-class docs section (after guide). |
| content/docs/guides/meta.json | Defines the Guides section metadata (title/description/root/icon/pages). |
| content/docs/guides/index.mdx | Adds the Guides catalog/landing page with standardized guide structure and interim links. |
This was referenced Jul 21, 2026
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
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.
Summary
Checkpoint 1 of the guides-section goal: scaffold a new top-level Guides section at
content/docs/guides/for end-to-end, step-by-step how-tos answering common Q&As — task-oriented walkthroughs, distinct from the conceptualguide/("How Coven Works") section.Changes
content/docs/guides/meta.json— new root nav section (title Guides, description Step-by-Step How-Tos,LuCompassicon)content/docs/guides/index.mdx— catalog page: what every guide contains (prerequisites, numbered steps, expected output, troubleshooting footer), planned-guide table, and interim links to existing docscontent/docs/meta.json— registerguidesafterguidelib/source.ts— addLuCompassicon mappingscripts/check-guides-docs.mjs— validation script mirroring the othercheck-*-docs.mjsscripts (pins root nav registration, meta title/description, required pages,read_whenfrontmatter, required mentions, cross-links)package.json—check:guides-docsscript chained intopnpm buildValidation
node scripts/check-guides-docs.mjs✅check-english-only,check-no-leading-h1,check-mermaid-parse,validate-links(0 errors) ✅npx tsc --noEmit✅pnpm build(with the new check chained) ✅ —/docs/guidesprerenderedNext checkpoints
Guides land one PR each, priority mined from
reference/troubleshooting.mdx: install & first run; connect a harness; daemon setup + health check; memory setup & inspection; fix a failed install; upgrading; scripting the API.