Repository navigation
Turn examples into canonical recipes - #5
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (59)
📝 WalkthroughWalkthroughThe repository is rebranded from examples to recipes, adds a technical-plan recipe and static site, strengthens catalog and badge validation, updates the publishing workflow, and refreshes Spacefast documentation links across recipe prompts. ChangesRecipe catalog and technical-plan publication
Estimated code review effort: 3 (Moderate) | ~25 minutes Sequence Diagram(s)sequenceDiagram
participant PublishWorkflow
participant CatalogTest
participant BuildManifest
participant ValidatePublishDir
PublishWorkflow->>CatalogTest: run catalog.test.mjs
CatalogTest->>BuildManifest: build manifest and generated catalog
CatalogTest->>ValidatePublishDir: validate published outputs
ValidatePublishDir-->>CatalogTest: accept matching recipe badge markers
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ffc2325cba
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| if ( | ||
| !html.includes("https://spacefast.com/badge.js") || | ||
| !html.includes(`data-example="${slug}"`) | ||
| (!html.includes(`data-recipe="${slug}"`) && !html.includes(`data-example="${slug}"`)) |
There was a problem hiding this comment.
Keep requiring data-example until the badge rollout
While the production badge lacks data-recipe support—as the new README rollout note explicitly states—an output containing only data-recipe now passes this validator. The publish workflow then deploys that output after validation, so a contributor adopting the new attribute early can publish a recipe whose badge cannot identify or load its catalog entry. Require data-example throughout the compatibility window, optionally allowing data-recipe only in addition.
Useful? React with 👍 / 👎.
Summary
Verification
Dependency / merge order
Summary by CodeRabbit
New Features
Documentation
Bug Fixes