docs(landing): add a prompt examples page - #98
Merged
Conversation
|
✅ CI - Verify PASSED Commit:
|
Task-based prompt library for the Memory group: save, recall, refresh, prune, cross-tool handover, and a standing-instructions snippet.
vreshch
force-pushed
the
feature/docs-prompt-examples
branch
from
August 23, 2026 14:13
66999b2 to
3ab65ce
Compare
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.
What
A new docs page, Prompt examples (
/docs/prompt-examples), placed in the Memory group between "Connect a client" and "MCP tools".Task-based sections, each with a short intro and a copy-ready prompt in a code block, captioned with the tools it lands on:
memory__write, andmemory__editfor appends)memory__search/memory__listthenmemory__read)memory__edit, frontmatter merge, full rewrite when warranted)CLAUDE.md/ rules-file / system-prompt snippet: check memory first, save durable decisions, never store secrets)Why
The docs explain how to connect and what the tools are, but not what to actually type. This is the page a new user copies from on day one, and it is where the cross-vendor story becomes concrete rather than a claim.
How
Authored as a
DocPagedata module (content/prompt-examples.ts) using the existingp/code/calloutblock types, registered inregistry.tsandnav.ts. Behavior claims match the canonical facts inlib/mcp-docs.ts(literal keyword search, write replaces, edit shallow-merges frontmatter, delete is recoverable, tools only fire on memory-relevant requests).Verification
npm run verifygreen (type-check, lint, format, vitest 48/48, next build - now 44 static pages, the page and its.mdmirror included)./docs/prompt-examplesreturns 200 and/docs/prompt-examples.mdrenders the full markdown mirror with the code fences intact.