docs: add evaluator-first Blog, Form Builder, and OpenAPI pages - #268
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. 2 Skipped Deployments
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a521368cee
ℹ️ 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".
Closes #262
Why
First-time readers need to decide whether a plugin fits before they reach installation and API detail. This tracer slice turns Blog, Form Builder, and OpenAPI into evaluator-first examples for a complete feature, a workflow-heavy feature, and a backend-only feature.
What changed
PluginDecisionMetacontract for technical plugin truth: topology, separate relationship, Preview maturity, concrete payload, adopter prerequisites, dependencies/external services, maintained framework paths, and canonical docs/demo/source identifiers.plugin-decision.ts, then composes it into the existingPluginMetainventory by key.representativeCopyseam./p/blogresult; Form and OpenAPI do not invent demos.AutoTypeTable.Factual boundaries
FormRendererroute → validated/stored submission; isolated transactions are required and public read/submission policy is explicit when auth is enabled./open-api/schemais the fixed suffix beneath the configured API base path; title/version/reference path are optional overrides with documented defaults; Scalar remains optional and loads from jsDelivr only when used.Validation
pnpm --filter @btst/codegen test— 12 files / 176 tests passedpnpm --filter @btst/codegen typecheckpnpm --filter @btst/codegen buildpnpm --filter btst-docs build— 56 static pages generatedpnpm --filter btst-playground typecheckpnpm --filter btst-playground buildpnpm check:product-proof— 8 assets / 206,291 bytespnpm test:product-proof— 10 tests passedpnpm lintpnpm test— codegen 176 tests and stack 1,043 tests passedBrowser evidence
Verified catalog plus all three detail pages at 1440×900 and 390×844 in light and dark modes:
/docsbase pathReview gate
Independent Standards and Spec reviews ran in parallel before commit. Initial findings were corrected, then the same reviewers performed focused re-reviews; both axes passed with no remaining findings.
Downstream manifest seam
The PR now checks in
packages/cli/plugin-decisions.jsonso downstream marketing can consume core technical facts immediately after merge without waiting for an@btst/codegenrelease or making a runtime cross-site request.schemaVersion: 1, with Blog, Form Builder, and OpenAPI underpluginsPLUGIN_DECISIONShttps://raw.githubusercontent.com/better-stack-ai/better-stack/main/packages/cli/plugin-decisions.json(commit pinning documented)@btst/codegen/plugin-decisions.json; confirmed present vianpm pack --dry-runpnpm --filter @btst/codegen plugin-decisions:generatepnpm --filter @btst/codegen plugin-decisions:checkThe same independent Standards and Spec reviewers performed a focused read-only re-review of this addition and both passed with no findings.