Repository navigation
feat(docs): add guided implementation prompts to task guides - #887
Open
aXenDeveloper wants to merge 1 commit into
Open
aXenDeveloper wants to merge 1 commit into
aXenDeveloper wants to merge 1 commit into
Conversation
Guides can declare optional `implementation` frontmatter (objective, decisions, constraints, related links), validated by the docs schema. Pages that declare it show "Copy implementation prompt", which copies a prompt built from one shared agent workflow: read the guide, inspect the project, settle the page's decisions with the user, then implement. Enabled on Threaded replies, Publish notifications and the widgets End-to-end Example. Contributor docs explain how to author the metadata. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0129cPmZegPiTUyX5NPnpdZ3
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. |
|
React Doctor found no new issues. 🎉 Reviewed by React Doctor for commit |
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
What?
Guides can now declare an optional
implementationfield in their frontmatter. A page that has it shows a Copy implementation prompt button next to Copy Markdown. One click copies a prompt for a coding agent: it links the guide and its.mdversion, tells the agent to inspect the reader's project and ask a short set of questions, then implement where the reader chose. Nothing is generated by AI and the docs site asks the reader nothing.Schema (
apps/web/src/docs/implementation/schema.ts): a strict zod schema added to the fumadocs page schema. Fields areobjective,decisions(1-6), optionalconstraints(up to 6) and optionalrelated(up to 4/docs/...links). Bad metadata fails the docs build and names the file. Pages without the field are unchanged.Prompt builder (
apps/web/src/docs/implementation/prompt.ts): a pure function holding the one shared agent workflow:Links are absolute on
SITE_ORIGIN.Button (
page-header.tsx): reuses the existingCopyButton, so it gets the same success state, screen-reader announcement and error toast.transport.tsnow also returns the page URL.Pilots: Threaded replies (comments), Publish notifications, and the widgets End-to-end Example. There is no reactions guide or reactions feature in the codebase, so none was enabled.
Contributor docs: an "Implementation prompts" section in
dev/contribution.mdx, plus a pointer to it in thevitnode-docsskill.Tests: 12 tests on Node's built-in runner in
apps/web/src/tests/, plus atestscript.apps/webhad no tests, and its lint config already supportsnode:test, so no new dependency was needed.Why?
A reader can paste one prompt into their coding agent and get the documented feature built into their own plugin and content type, instead of the guide's example names. Each guide keeps only a few lines of metadata, and the tutorial stays the single technical reference. The metadata does not appear in the article, the
.mdexport,/llms.txtor/llms-full.txt.Checks
pnpm typecheckandpnpm lintinapps/webpass.pnpm testpasses (12/12).pnpm buildinapps/webpasses.oxfmt --check.pnpm checkinapps/webfails on the same 103 files before and after this change; none of them are touched here.Generated by Claude Code