feat(docs): ExampleCode include + guards; retire the walkthrough renderer - #1025
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
blove
enabled auto-merge (squash)
September 5, 2026 23:29
Contributor
…, walkthrough retirement Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…, walkthrough machinery removal Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…TML markers Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ough the docs MDX pipeline Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…am-free code card Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…rces stay server-side Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
… failure messages Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…es to dist/ Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ple; wrap long ExampleCode titles Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…longer a registry asset Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…e bundle Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…alytics hook Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…ed; drop the last narrative CSS Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…hem; retitle the prose layer comment Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
…X pages name their route in ExampleCode errors; spec matches the shipped rendering path Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
blove
force-pushed
the
blove/docs-example-first-infra
branch
from
September 5, 2026 23:29
0e6c105 to
d02552c
Compare
Contributor
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.
PR 1 of the example-first docs program (spec:
docs/superpowers/specs/2026-09-05-docs-example-first-content-design.md, plan:docs/superpowers/plans/2026-09-05-docs-example-first-infrastructure.md).<ExampleCode file= region= title=>renders a docs page's example files through the docs MDX pipeline (same highlighting, copy button, styles; titled card;role="group"). Unresolvable includes fail the build naming the page. Raw sources travel only to the server-rendered component; the client workspace getscodeSources: {}.apps/website/src/lib/docs-example-code.spec.ts: mapped pages include their example (40 pending, streaming converted), includes resolve by the component's own rule, docs-only pages never include, and the suite cannot pass vacuously.docsAssetPaths(registry, 41 example modules, regenerateddeployments/ag-ui-dev),renderMarkdown,NarrativeDocs,trackNarrativeAction, narrative CSS. The 41cockpit/**/docs/guide.mdfiles stay until each product PR absorbs them.Verification:
nx run-many -t test,lintgreen on cockpit-registry, cockpit-shell, workspace-react, website, scripts;nx buildfor the three libs;GROWTH_FORM_POLICY=growth_v1 nx build websiterenders the streaming include (data-example-filepresent, highlightedpre); mutation check withfile="nope.ts"fails the build with the page-named error.Follow-ups (not here): drop the now-unused
markedfromlibs/cockpit-shell/package.json(lockfile edit); decideCodeGroup×ExampleCodesupport in PR 2.🤖 Generated with Claude Code