Skip to content

Turn examples into canonical recipes - #5

Merged
batuhan merged 2 commits into
masterfrom
batuhan/recipes-unification
Jul 27, 2026
Merged

batuhan merged 2 commits into
masterfrom
batuhan/recipes-unification

Conversation

@batuhan

@batuhan batuhan commented Jul 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Reframes the historical examples repository as the canonical Recipes catalog.
  • Retains the production-safe data-example badge attribute during the shared-badge rollout.
  • Adds the Technical planning recipe with a complete responsive, accessible static output.
  • Strengthens the plan with explicit scope assumptions, likelihood/impact risks, complete decision records, and a review checklist.
  • Runs catalog/output tests in CI and updates authoring documentation.

Verification

Dependency / merge order

  1. This PR can merge and publish first because it retains data-example compatibility with the current production badge.
  2. Then merge https://github.com/spacefast/monorepo/pull/919 to deploy the Recipes routes, setup integration, and data-recipe support.

Summary by CodeRabbit

  • New Features

    • Added a new Northstar Sync technical planning recipe with an accessible, responsive static website covering architecture, milestones, risks, decisions, and open questions.
    • Added catalog coverage to verify recipe metadata, generated pages, publishing outputs, and required content.
  • Documentation

    • Rebranded “Examples” as “Recipes” across the catalog and publishing guidance.
    • Updated publishing, claiming, setup, and version-management links to the latest help pages.
  • Bug Fixes

    • Improved validation for recipe badge markers and clearer prompt errors.

@coderabbitai

coderabbitai Bot commented Jul 26, 2026 •

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: f2e455fe-67fe-4ea3-9ad1-c78b59bbd667

📥 Commits

Reviewing files that changed from the base of the PR and between 806e128 and ffc2325.

📒 Files selected for processing (59)
  • .github/workflows/publish.yml
  • README.md
  • TEMPLATE.md
  • examples/2048/prompt.md
  • examples/app/prompt.md
  • examples/arcade/prompt.md
  • examples/band/prompt.md
  • examples/barber/prompt.md
  • examples/blog/prompt.md
  • examples/calories/prompt.md
  • examples/changelog/prompt.md
  • examples/cli/prompt.md
  • examples/conference/prompt.md
  • examples/dashboard/prompt.md
  • examples/deck/prompt.md
  • examples/docs/prompt.md
  • examples/foodtruck/prompt.md
  • examples/fundraiser/prompt.md
  • examples/game/prompt.md
  • examples/garden/prompt.md
  • examples/generative-art/prompt.md
  • examples/habits/prompt.md
  • examples/hackathon/prompt.md
  • examples/invitation/prompt.md
  • examples/links/prompt.md
  • examples/listing/prompt.md
  • examples/memorial/prompt.md
  • examples/menu/prompt.md
  • examples/newsletter/prompt.md
  • examples/notes/prompt.md
  • examples/party/prompt.md
  • examples/photos/prompt.md
  • examples/portfolio/prompt.md
  • examples/proposal/prompt.md
  • examples/qr/prompt.md
  • examples/recipes/prompt.md
  • examples/report/prompt.md
  • examples/resume/prompt.md
  • examples/revenue-review/prompt.md
  • examples/roi/prompt.md
  • examples/saas/prompt.md
  • examples/savings/prompt.md
  • examples/soon/prompt.md
  • examples/status/prompt.md
  • examples/studio/prompt.md
  • examples/technical-plan/README.md
  • examples/technical-plan/meta.json
  • examples/technical-plan/prompt.md
  • examples/technical-plan/site/index.html
  • examples/technical-plan/site/styles.css
  • examples/tip/prompt.md
  • examples/word-game/prompt.md
  • examples/wp-astro/prompt.md
  • examples/wp-react/prompt.md
  • examples/zine/prompt.md
  • meta.example.json
  • scripts/build-manifest.mjs
  • scripts/catalog.test.mjs
  • scripts/validate-publish-dir.mjs

📝 Walkthrough

Walkthrough

The 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.

Changes

Recipe catalog and technical-plan publication

Layer / File(s) Summary
Catalog workflow and validation
.github/workflows/publish.yml, README.md, meta.example.json, scripts/*
Publishing runs catalog tests, generated output uses recipe terminology, and validation accepts both historical and recipe badge attributes.
Technical-plan recipe definition
examples/technical-plan/README.md, meta.json, prompt.md
Adds metadata, planning requirements, accessibility constraints, and publishing instructions for the technical-plan recipe.
Technical-plan static site
examples/technical-plan/site/*
Adds the complete HTML and responsive, printable styling for the technical planning artifact.
Publishing references across recipes
TEMPLATE.md, examples/*/prompt.md
Updates Spacefast setup and help links in the template and existing recipe prompts.

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
Loading
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch batuhan/recipes-unification

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

@batuhan
batuhan marked this pull request as ready for review July 27, 2026 06:18
@batuhan
batuhan merged commit 2f1ab83 into master Jul 27, 2026
53 of 54 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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}"`))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge 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 👍 / 👎.

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