openprez / showcase
AGENTS.md1 starsChanged 2 days agoMITView on GitHub
Use this guide only when changing showcase/, the reference deck served by the development server at /showcase.html (via the app/showcase.tsx entry; never a production build input). The root AGENTS.md is the source of shared project boundaries, slide-design and shell rules, theme/assets guidance, and validation scope; this file adds only showcase-specific rules.
Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.
Of the AGENTS.md files we read, the 31,439 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.
In this repository23 other files it gives its agents.
- AGENTS.mdAGENTS.md
- core/AGENTS.mdAGENTS.md
- presentation/AGENTS.mdAGENTS.md
- build-slideSkill
- build-templateSkill
- openprezSkill
- openspec-apply-changeSkill
- openspec-archive-changeSkill
- openspec-bulk-archive-changeSkill
- openspec-continue-changeSkill
- openspec-exploreSkill
- openspec-ff-changeSkill
- openspec-new-changeSkill
- openspec-onboardSkill
- openspec-proposeSkill
- openspec-sync-specsSkill
- openspec-update-changeSkill
- openspec-verify-changeSkill
- opp-applySkill
- opp-archiveSkill
- opp-exploreSkill
- opp-proposeSkill
- promote-to-coreSkill
The file
We split this AGENTS.md into the rules it gives an agent
3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈0
Distinctive · estimate
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 5
Purpose: keep this deck a clear example of the foundation's public @core API and player capabilities.
- Very specific: line 7
Slide files: put one slide component per file in showcase/slides/, and declare it with defineSlide({ id, steps, tone, notes, Component }) …
- Very specific: line 8
Imports: import foundation features only from @core.
≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Showcase deck rules
Use this guide only when changing showcase/, the reference deck served by the development server at /showcase.html (via the app/showcase.tsx entry; never a production build input). The root AGENTS.md is the source of shared project boundaries, slide-design and shell rules, theme/assets guidance, and validation scope; this file adds only showcase-specific rules.
- Purpose: keep this deck a clear example of the foundation's public
@coreAPI and player capabilities. Do not use it as the user's own presentation; that is the starter deck inpresentation/, replaced by the user's first change. - Entry point:
showcase/deck.tsxexportsdefineDeck({ title, date?, slides }). Itsslidesarray defines order. - Slide files: put one slide component per file in
showcase/slides/, and declare it withdefineSlide({ id, steps, tone, notes, Component })using a uniqueid. - Imports: import foundation features only from
@core; use relative imports for files insideshowcase/. Never deep-import fromcore/or import@template/**. - Assets: store showcase-only assets in
showcase/assets/and import them by relative path.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.