docs(demos+examples): cover advertised entries with missing READMEs (round 2, SD-3217)#3393
Closed
caio-pizzol wants to merge 1 commit into
Closed
docs(demos+examples): cover advertised entries with missing READMEs (round 2, SD-3217)#3393caio-pizzol wants to merge 1 commit into
caio-pizzol wants to merge 1 commit into
Conversation
…round 2, SD-3217)
Second execution PR after the demos/examples taxonomy audit. Adds
READMEs to 10 manifest entries that were advertised but undocumented
in the source tree. No file moves, no manifest schema changes; this
PR only writes READMEs so the surviving public surface is no longer
misleading.
Each README is 25-50 lines and follows the same shape:
- What this teaches (one sentence + supporting bullets).
- How to run.
- When to reach for it.
- When not (with a pointer to the better-fit alternative).
- One docs link.
- For AI examples, required env vars called out explicitly.
Entries covered:
- demos/chrome-extension: root README explains the wrapper/extension
directory split and links to the existing nested README at
chrome-extension/chrome-extension/.
- examples/getting-started/nextjs: Next.js App Router starter with
SSR-boundary notes.
- examples/editor/built-in-ui/{comments,track-changes,toolbar}: the
three built-in UI module setups, each with a when-not pointer to
the custom-UI path.
- examples/editor/theming: --sd-* token override + runtime theme
switcher.
- examples/document-engine/diffing: side-by-side DOCX comparison
rendered as tracked changes.
- examples/ai/redlining: browser-side AI suggestions applied as
tracked changes (requires VITE_OPENAI_API_KEY).
- examples/document-engine/ai-redlining: headless Node version of
the same flow (requires OPENAI_API_KEY).
- examples/advanced/headless-toolbar: parent index pointing at the
five framework variants (vanilla, react-mui, react-shadcn,
svelte-shadcn, vue-vuetify), each a standalone workspace.
Variants under headless-toolbar are not given individual READMEs in
this PR; the parent index documents them. Per-variant READMEs can
land later if reviewers ask.
Validator (bun scripts/validate-examples-demos.ts) passes. Zero
em-dashes in any new file.
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.
Second execution PR after SD-3217. Round 1 (#3391) removed 6 legacy demos from the gallery; this PR fills in READMEs for the 10 entries that are advertised in
demos/manifest.jsonorexamples/manifest.jsonbut had no documentation in the source tree.No file moves, no manifest schema changes, no source touched outside the new README files.
Entries covered
demos/chrome-extensionchrome-extension/chrome-extension/.examples/getting-started/nextjsexamples/editor/built-in-ui/commentsexamples/editor/built-in-ui/track-changesexamples/editor/built-in-ui/toolbartoolbarmodule.examples/editor/theming--sd-*token override + runtime theme switcher.examples/document-engine/diffingexamples/ai/redliningVITE_OPENAI_API_KEY).examples/document-engine/ai-redliningOPENAI_API_KEY).examples/advanced/headless-toolbarvanilla,react-mui,react-shadcn,svelte-shadcn,vue-vuetify).README shape
Per Codex's review on round 1, each README is 25-50 lines and follows the same structure:
Notable calls
demos/chrome-extension: root README written (notsourcePathrepointed). The existing nestedchrome-extension/chrome-extension/README.mdstays as the extension package's own docs; the new root README explains the wrapper layout and links inward. Less manifest churn, more obvious to anyone scanning the directory.examples/advanced/headless-toolbar: one parent README acts as an index for the five variants. Variants are not individually advertised inexamples/manifest.json(the entry stays one); per-variant READMEs can land later if reviewers want them. Keeps round 2 bounded and avoids flooding the examples gallery with five near-duplicates of the same primitive.Verified
bun scripts/validate-examples-demos.ts: passes.mainpost-chore(demos): de-advertise 6 legacy demos (round 1, SD-3217) #3391 merge.Queue position
Round 3 (per SD-3217's execution plan): consolidate
demos/nextjs-ssrintoexamples/getting-started/nextjsnow that the latter has a README. Round 4: manifest typing + status. Holds until this PR lands.