feat(docs): add source-backed guide snippets#92
Merged
Conversation
added 2 commits
June 5, 2026 01:01
Introduce region-marker extraction so guide code blocks are pulled directly from type-checked source files instead of being manually maintained inline. Missing file, missing region, empty region, and duplicate regions all fail the Astro SSG build with actionable errors.
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.
Problem
Guide snippets can drift from examples and templates — code is manually duplicated and not type-checked against the real source.
Solution
Source-backed snippet regions with build-time validation:
site/src/lib/source-snippets.ts— pure utility withextractSnippetRegion()site/src/components/SourceSnippet.astro— MDX component (SSG, build-time extraction)// #region guide:<name>/// #endregion guide:<name>Implementation note
repoRoot()walks up fromprocess.cwd()looking forpnpm-workspace.yamlinstead of usingimport.meta.dirname. This is required because Astro SSG bundles the component intosite/dist/.prerender/chunks/, makingimport.meta.dirnamepoint to the bundle output rather than the source directory.Scope
Docs/tooling foundation with a small representative migration (~3–4 snippets from orb-dodge walkthrough and first-scene guide).
Validation