Repository navigation
docs: group the site into guides, recipes, and package pages - #47
Conversation
Shared guides for renderers, theming, validation, and agents replace the sections each package page copied. Recipes show annotate with zoom groups, carousels, and a whole review document. The sidebar groups every page, and a package's For agents button installs only its own skill.
Latest result Pull request merged. Final answersSession Pull request merged. Session Waiting for GitHub merge request 4c36e631-7857-4c43-823a-39ae379f788b. No valid P0/P1 review findings remain; Pullfrog’s prior validation finding is resolved. The sole failing check is an environment/browser timeout, with the exact base passing, so no repair commit was made. Session Narrowed the validation guide metadata to plugins that validate blocks, pushed commit a9ee620, and resolved Pullfrog’s P2 documentation finding. The prior E2E timeout was an environment/browser context-menu failure with 37/38 tests passing and no code-local reproduction. Awaiting current-head checks. Session Narrowed the validation guide metadata to plugins that validate blocks, pushed commit a9ee620, and resolved Pullfrog’s P2 documentation finding. The prior E2E timeout was an environment/browser context-menu failure with 37/38 tests passing and no code-local reproduction. Awaiting current-head checks. Session Waiting for review checks before the next pass. Session Waiting for review checks before the next pass. Session Waiting for review checks before the next pass. |
🚀 Deploying Preview to Cloudflare 🚀Preview Deployments by commit
|
comark-annotate
comark-carousel
comark-charts
comark-embed
comark-github-callouts
comark-include
comark-lint
comark-tabs
comark-zoom
commit: |
![pullfrog[bot]](https://avatars.githubusercontent.com/in/1768019?s=60&v=4){kind=small}
There was a problem hiding this comment.
ℹ️ One documentation claim is broader than the implementation; minor suggestion inline.
Reviewed changes
- Docs structure — Added shared Guides and Recipes pages, grouped package pages into generated sidebar and index cards, and added a responsive table of contents and mobile menu.
- Docs generator — Added route metadata, group-aware cards/navigation, per-package agent-skill commands, and generated pages for the new content.
- Package documentation — Removed duplicated renderer, theming, and validation sections from package pages and updated links and README references.
- Validation coverage — Expanded Vite Doctor's Markdown glob to cover nested guide and recipe pages and replaced the old index component with
cards.
gpt-5.6-sol ｜ 𝕏
There was a problem hiding this comment.
ℹ️ No new issues found in the incremental changes. The charts page registration and homepage tagline are consistent with the existing docs generator, and
pnpm docs:buildcompleted successfully.
Reviewed changes
- Charts page registration — Added
comark-chartsto the generated page list and grouped it under Review blocks, so the existing charts documentation is rendered and linked by the site. - Site tagline — Updated the homepage metadata to mention charts alongside the other available plugins.
The prior Pullfrog finding about the broad Validation page description remains open and was not changed by this incremental delta.
gpt-5.6-sol ｜ 𝕏
…op the example frame around a lone card The chart rules set height:auto on every SVG in the plot, so annotate's arrow stretched to its viewBox and ran past its head, and the circle squashed. They now reach only the chart's own SVG. A chart, a link card, or a diff draws its own card, so its docs example no longer frames it a second time.
…="none" The box around a marked point grows to fit a circle, so with nothing drawn the arrow stopped about 20px short. A bare mark now keeps its box tight to the point.
There was a problem hiding this comment.
ℹ️ No new issues were introduced by this incremental change; the existing validation metadata finding remains unresolved.
Reviewed changes
- Chart sizing — Narrowed the chart CSS selectors so direct-child sizing applies to the chart SVG without stretching annotation circles and arrows, while preserving marked-chart print and responsive sizing.
- Example framing — Added charts, link cards, and diffs to the standalone-preview rules so their own cards are not nested inside the example frame.
- Documentation links — Updated package documentation links to the new guide and recipe routes.
gpt-5.6-sol ｜ 𝕏
There was a problem hiding this comment.
ℹ️ No new issues were introduced by the latest incremental change; the existing validation metadata finding remains unresolved.
Reviewed changes
- Annotation arrow placement — Reduced the padding used for
mark="none"chart boxes so side-note arrows reach the marked data point without changing visible mark sizing.
gpt-5.6-sol ｜ 𝕏
There was a problem hiding this comment.
✅ No new issues found.
Reviewed changes
- Validation metadata — Narrowed the guide's description and tagline to plugins that validate blocks, matching the page's documented
meta.issuesbehavior and resolving the prior review finding.
pnpm docs:build passes and generates all 16 documentation routes.
gpt-5.6-sol ｜ 𝕏
1 participant
Groups the docs site into guides, recipes, and package pages. Package pages had each copied the same Renderers, Theming, and Validation sections; shared guides replace those copies.
What changes
/guide/: Renderers (which entry each package has, several plugins in one renderer, scripts and styles, CSP), Theming (the--comark-*tokens, the Nuxt UI mapping, each plugin's own variables), Validation (meta.issuesand what each plugin reports), and Agents (the skills)./recipes/: a whole review document, screenshots in a zoom group, and screenshots in a carousel.--skill comark-annotate).doctor.config.tslintsdocs/pages/**/*.md, so the guides and recipes are checked too.Rebase onto main
This was written before
comark-tabs(#37) and the lint fixes (#43). The rebase:::examplesname for the docs-only example tabs, since::tabsbelongs to comark-tabs now.doctor.config.tslistscards,example, andexamples.comark-code(#46) is stacked on this branch.Checks
pnpm docs:buildwrites every page,/guide/*and/recipes/*included.pnpm run lint:docsreports 0 warnings, andvp fmt --checkpasses.pnpm readypasses (178 tests), and so does every Playwright e2e test (43 of 43).🤖 Generated with Claude Code