Skip to content

feat(docs): remove the primitives and recipes pages, keep the exports - #157

Merged
hunterbecton merged 2 commits into
mainfrom
hunter/sha-136-remove-primitives-pages
Sep 8, 2026
Merged

feat(docs): remove the primitives and recipes pages, keep the exports#157
hunterbecton merged 2 commits into
mainfrom
hunter/sha-136-remove-primitives-pages

Conversation

@hunterbecton

Copy link
Copy Markdown
Contributor

Why

The eleven primitive pages and five recipe pages still wore launch placeholder styling, and their slider playgrounds duplicate what the editor does better. SHA-136 decided the primitives stay exported, because eject-to-code imports them by name, but get no doc pages.

What changes

The routes and their data go

/primitives, /recipes, both data files, and the five docs components that only served them are deleted. The Primitives sidebar group, the catalog nav item kind, and the primitives entries in the search index go with them, since nothing else used them. The Engine API page keeps its Tier 2 list as bare signatures.

The header's Examples link points at /examples

It pointed at /recipes as the nearest thing to examples. /examples is the placeholder page SHA-135 will design, so the link never 404s.

AGENTS.md describes a two-tier model

Tier 3 recipes no longer exist anywhere, so the project-shape paragraph drops them and records why the primitives stay exported.

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: fe74dc9b-f11d-4b68-a2a5-d7ae123977db

📥 Commits

Reviewing files that changed from the base of the PR and between 24f293b and 27993cb.

📒 Files selected for processing (28)
  • AGENTS.md
  • apps/docs-tests/a11y/component-pages.spec.ts
  • apps/docs/content/docs/examples.mdx
  • apps/docs/content/docs/getting-started.mdx
  • apps/docs/content/docs/reference/shaders.mdx
  • apps/docs/src/app/primitives/[slug]/page.tsx
  • apps/docs/src/app/primitives/layout.tsx
  • apps/docs/src/app/primitives/page.tsx
  • apps/docs/src/app/recipes/[slug]/page.tsx
  • apps/docs/src/app/recipes/_builds.ts
  • apps/docs/src/app/recipes/page.tsx
  • apps/docs/src/components/PrimitiveDemo.tsx
  • apps/docs/src/components/PrimitiveScene.tsx
  • apps/docs/src/components/PropsPlayground.tsx
  • apps/docs/src/components/RecipeScene.tsx
  • apps/docs/src/components/RecipeViewer.tsx
  • apps/docs/src/components/code-block/code-block.tsx
  • apps/docs/src/components/docs-shell/docs-shell.tsx
  • apps/docs/src/components/primitive-params.ts
  • apps/docs/src/components/site-header/site-header.tsx
  • apps/docs/src/content/catalog.ts
  • apps/docs/src/content/nav.config.ts
  • apps/docs/src/content/nav.test.ts
  • apps/docs/src/content/nav.ts
  • apps/docs/src/content/search.ts
  • apps/docs/src/content/types.ts
  • apps/docs/src/data/primitives.ts
  • apps/docs/src/data/recipes.ts
💤 Files with no reviewable changes (17)
  • apps/docs/content/docs/examples.mdx
  • apps/docs/src/app/primitives/page.tsx
  • apps/docs/src/app/primitives/[slug]/page.tsx
  • apps/docs/src/data/primitives.ts
  • apps/docs/src/app/recipes/page.tsx
  • apps/docs/src/components/RecipeViewer.tsx
  • apps/docs-tests/a11y/component-pages.spec.ts
  • apps/docs/src/components/primitive-params.ts
  • apps/docs/src/data/recipes.ts
  • apps/docs/src/app/primitives/layout.tsx
  • apps/docs/src/content/nav.config.ts
  • apps/docs/src/app/recipes/_builds.ts
  • apps/docs/src/components/RecipeScene.tsx
  • apps/docs/src/components/PropsPlayground.tsx
  • apps/docs/src/components/PrimitiveScene.tsx
  • apps/docs/src/app/recipes/[slug]/page.tsx
  • apps/docs/src/components/PrimitiveDemo.tsx

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Summary

Summary by CodeRabbit

  • Documentation

    • Updated shader reference content to describe exported TSL building blocks without individual primitive pages.
    • Clarified Next.js 15+ requirements for the documentation site.
    • Updated examples and component documentation references.
  • Changes

    • Removed the Primitives and Recipes documentation sections, including their pages, navigation links, demos, and search entries.
    • Redirected the Examples navigation link to /examples.
    • Accessibility coverage no longer includes the removed Recipes page.

Walkthrough

The docs site removes primitive and recipe pages, data, demos, catalog entries, and navigation. It updates search, accessibility coverage, documentation links, project guidance, and catalog types for a component-focused structure.

Changes

Documentation surface removal

Layer / File(s) Summary
Remove primitive and recipe pages and supporting code
apps/docs/src/app/primitives/*, apps/docs/src/app/recipes/*, apps/docs/src/components/Primitive*, apps/docs/src/components/PropsPlayground.tsx, apps/docs/src/components/Recipe*, apps/docs/src/components/primitive-params.ts, apps/docs/src/data/primitives.ts, apps/docs/src/data/recipes.ts
Primitive and recipe pages, shader demos, playground controls, scene components, registries, and data entries are deleted.
Simplify catalog, navigation, and search
apps/docs/src/content/catalog.ts, apps/docs/src/content/nav.ts, apps/docs/src/content/nav.config.ts, apps/docs/src/content/types.ts, apps/docs/src/content/search.ts, apps/docs/src/content/nav.test.ts
Catalog records and search documents become component-only. Primitive sections and catalog navigation types are removed. Navigation tests target Components.
Update documentation entry points
AGENTS.md, apps/docs-tests/a11y/component-pages.spec.ts, apps/docs/content/*, apps/docs/src/components/code-block/code-block.tsx, apps/docs/src/components/docs-shell/docs-shell.tsx, apps/docs/src/components/site-header/site-header.tsx
References to primitive and recipe pages are removed. The Examples link targets /examples, and accessibility coverage no longer includes /recipes.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Merge Risk: ⚪ Minimal · up to 27993

Documentation navigation and search now omit the removed primitive and recipe content while preserving component documentation and primitive package exports. No merge-blocking current-head risk is evidenced.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 8 files. (3 skipped: 3… Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: removing the primitives and recipes pages while retaining the primitive exports.
Description check ✅ Passed The description directly explains the route, data, navigation, search-index, and export changes in the pull request.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 2 functions across 8 files. (3 skipped: 3 unsupported.)

  • Fix all pre-merge checks with AI
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch

Warning

Some tools did not complete. Review the errors below.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration.


Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

React Doctor found no new issues. 🎉

Reviewed by React Doctor for commit 27993cb.

@hunterbecton

Copy link
Copy Markdown
Contributor Author

@CodeRabbit review

@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@hunterbecton
hunterbecton merged commit 56fa628 into main Sep 8, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant