docs(site): refresh write-guides page and align docs skill Diátaxis guidance#1809
Merged
Conversation
…uidance The write-guides page had drifted from the docs skill and the current MDX pipeline: - Fix the tip aside's skill name (docs-guide → docs) - Replace the unsupported styles sidebar restriction with a StyleCase note, and fix the stale title field (actual field is sidebarLabel) - Document the satteriCodeFrame auto-wrap and title="..." fence meta - Reword the ServerCode caution against current behavior (still a bare pre) - Add the missing Demo component section with live examples - Move the canonical Diátaxis guidance (concept-first default + decision table) onto the page; the docs skill now defers to it Closes #1808 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jk33yY4w5PkThQjkysDWgc
…-guides Add the two-question compass with our three-mode mapping, note the deliberately absent tutorials mode, fold mode-quality hints into the mode list, and state the don't-mix-modes rule after the decision table. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jk33yY4w5PkThQjkysDWgc
✅ Deploy Preview for vjs10-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
📦 Bundle Size Report🎨 @videojs/html — no changesPresets (7)
Media (10)
Players (5)
Skins (30)
UI Components (39)
Sizes are marginal over the root entry point. ⚛️ @videojs/react — no changesPresets (7)
Media (9)
Skins (27)
UI Components (33)
Sizes are marginal over the root entry point. 🧩 @videojs/core — no changesEntries (14)
🏷️ @videojs/element — no changesEntries (2)
📦 @videojs/store — no changesEntries (3)
🔧 @videojs/utils — no changesEntries (10)
📦 @videojs/spf — no changesEntries (4)
ℹ️ How to interpretJS sizes are initial static graph totals (minified + brotli). Lazy dynamic chunks are shown separately when present.
Run |
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jk33yY4w5PkThQjkysDWgc
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
3 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.
Closes #1808
The
docsskill declareswrite-guides.mdxa source of truth, but the two had drifted and the page had gone stale. This refreshes the page against the current MDX pipeline and makes it the canonical home for the Diátaxis guidance, with the skill deferring to it.Staleness fixes (
site/src/content/docs/how-to/write-guides.mdx)docs-guideskill — it's nameddocs.styles: ['css']restriction (style is a client-side preference; every guide renders for all styles — use<StyleCase>in content). Also fixed the staletitle:field found along the way — the actualGuidefield issidebarLabel(site/src/types/docs.ts), which defaults to the guide'stitlefrontmatter.satteriCodeFrameauto-wrap — every standalone fence renders inside a<CodeFrame>, withtitle="..."fence meta for filenames, and blocks inside an authored<TabsPanel>left alone — including a renderedtitle="App.ts"example.<ServerCode>caution re-verified: still accurate (it renders a bare<pre>viaShared.tsx); reworded to contrast with the new fence auto-wrapping and fixed theTabPanel→TabsPaneltypo.<Demo>: added the missing section —filesprop shape, automatic CSS scoping, framework-specific wrapping — with live play-button demos rendered for both React and HTML routes.Diátaxis alignment
write-guides.mdxfor the full guidance instead of duplicating the decision table.Verification
pnpm build:sitepasses (14/14 tasks).devOnly, so it was also verified against the dev server: both/docs/framework/react/how-to/write-guidesand/docs/framework/html/how-to/write-guidesrender, with the new sections, code-frame example, and live demos present.🤖 Generated with Claude Code
https://claude.ai/code/session_01Jk33yY4w5PkThQjkysDWgc
Generated by Claude Code
Note
Low Risk
Documentation and Claude skill text only; no runtime or API behavior changes.
Overview
Makes
write-guides.mdxthe single canonical place for Diátaxis guidance and brings the page in line with the current docs toolchain.The
docsskill now keeps only a compact mode table and points authors towrite-guides.mdxinstead of duplicating the concept vs how-to decision table.write-guides.mdxgains the full Diátaxis material (compass, tutorials omission, decision table, don’t-mix-modes), fixes stale author guidance (docsskill name, sidebar usessidebarLabelnottitle, nostyleson sidebar items), and documents auto<CodeFrame>wrapping,title="..."on fences, updated<ServerCode>vs frames, plus a new<Demo>section with live React/HTML play-button examples.Reviewed by Cursor Bugbot for commit e163bf0. Bugbot is set up for automated code reviews on this repo. Configure here.