feat(docs-site): theme reference diagrams and render @components / GUIDE prose#2260
Merged
Merged
Conversation
…in reference Extend the typedoc-custom plugin so generated reference pages: - render Mermaid step-flow diagrams with the brand palette (handDrawn, base/accent theming) via @docusaurus/theme-mermaid - render a Sub-components table from the @components block tag - slot GUIDE.md prose into flow/hook pages with provenance fences The @components tag is registered in typedoc.config so TypeDoc keeps the built-in tags alongside it. Renders harmlessly empty until source files carry @components tags and GUIDE.md prose (follow-up content PRs). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
- register @components as a TSDoc block tag (tsdoc.json) and teach the tsdoc-sort-tags eslint rule to place it in its own group - exempt **/GUIDE.md from prettier (authored prose, not generated) - derive-commit clears docs/reference before applying artifacts so pages whose path changed are staged as deletions rather than lingering Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
mariechatfield
added a commit
that referenced
this pull request
Jun 24, 2026
Prepares the skill for the doc-generation engine landing in #2260: - @components block tag: registered TSDoc tag listing a flow's composed blocks/hooks as {@link} refs; renders a Sub-components table. Documented in SKILL.md (tag order: own group after @remarks, before @param) and in the flows guide as the primary user - GUIDE.md prose slot: note in flows and hooks guides that long-form narrative lives in a colocated, Prettier-exempt GUIDE.md slotted into the generated reference page, kept distinct from concise @remarks. Flagged that GUIDE.md authoring conventions are still being set in follow-up guide-content PRs, so don't backfill prose speculatively Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
serikjensen
approved these changes
Jun 24, 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
2 participants
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
Extracts the stable doc-generation engine + supporting tooling from the larger guide-content effort (
docs/marie/add-guide-content) so it can be reviewed and merged independently while per-workflow content keeps being refined.Source only —
docs/reference/is regenerated by CI'sderive-commit.Engine (
feat)Extends the typedoc-custom plugin so generated reference pages:
@docusaurus/theme-mermaid@componentsblock tagGUIDE.mdprose into flow/hook pages with provenance fencesTooling (
build)@componentsas a TSDoc block tag and teach thetsdoc-sort-tagseslint rule to give it its own group**/GUIDE.mdfrom prettier (authored prose, not generated)derive-commitclearsdocs/referencebefore applying artifacts so renamed/removed pages are staged as deletionsThe engine renders harmlessly empty until source files carry
@componentstags andGUIDE.mdprose — those land in follow-up content PRs.Verification
tsdoc-sort-tagsrule tests pass🤖 Generated with Claude Code