research-slides
AGENTS.md4 starsChanged 3 months agoMITView on GitHub
This repository is Codex-first. Its primary deliverable is a portable research-slides Skill that Codex can use to turn research material into evidence-grounded, citation-aware HTML presentations. Do not add Claude Code-specific marketplace, command, or plugin packaging unless explicitly requested in a future task. When working in this repository: Supporting files currently include: The project should solve this job: Given a paper, research notes, data, or an existing research deck, produce a clear, visually strong presentation while preserving scientific traceability. The key…
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,774 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 repositoryOne other file it gives its agents.
- research-slidesSkill
The file
Show its rules and text
We split this AGENTS.md into the rules it gives an agent
26 rules. About 0 are common, 20 are distinctive, and 6 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈20
Distinctive · estimate
This author's own choices. Worth a look.
6
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 7
Do not add Claude Code-specific marketplace, command, or plugin packaging unless explicitly requested in a future task.
- Distinctive: line 11
When working in this repository:
- Distinctive: line 14
Read only the supporting files needed for the current task.
- Distinctive: line 51
When improving the Skill, write instructions that Codex can actually follow:
- Distinctive: line 59
Avoid advice such as “make it professional” without concrete implementation rules.
- Very specific: line 63
Keep SKILL.md as the workflow entry point.
- Very specific: line 71
read only shortlisted preview.md files.
- Very specific: line 73
after selection, read exactly the selected design.md unless the user explicitly requests a mixed system.
- Distinctive: line 75
Do not preload every template design file.
- Very specific: line 79
Do not require Claude Code-specific commands, marketplace manifests, or .claude-plugin files.
- Distinctive: line 81
Do not assume one IDE or one Codex client unless the feature truly requires it.
- Distinctive: line 83
If a Codex-specific capability is added, document a portable fallback where practical.
- Distinctive: line 87
Never introduce fabricated citations, numbers, experimental results, equations, or figure attributions into examples or generated assets.
- Distinctive: line 89
When a demo uses a real paper or dataset, keep a claim/source map or equivalent traceability artifact.
- Distinctive: line 111
Do not convert slides into responsive webpages that reflow at mobile widths.
- Very specific: line 113
Use viewport-base.css as the canonical stage behavior.
- Distinctive: line 125
no broken local assets
- Very specific: line 127
Run python scripts/validate_slides.py <presentation.html> when a local checkout is available, then perform rendered visual review …
- Distinctive: line 133
every referenced support file exists
- Distinctive: line 135
no contradictory instructions exist across support files
- Distinctive: line 140
Keep names descriptive and stable.
- Distinctive: line 141
Avoid duplicate copies of large instructions unless packaging requires them.
- Distinctive: line 142
Prefer small scripts that validate or transform artifacts over large framework dependencies.
- Distinctive: line 143
Do not add a build system unless it clearly improves the Skill workflow.
- Distinctive: line 144
Do not add a framework just to make the demo look more sophisticated.
- Distinctive: line 145
Keep human-facing gallery assets separate from agent runtime instructions.
≈ “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
AGENTS.md
Purpose
This repository is Codex-first. Its primary deliverable is a portable research-slides Skill that Codex can use to turn research material into evidence-grounded, citation-aware HTML presentations.
Do not add Claude Code-specific marketplace, command, or plugin packaging unless explicitly requested in a future task.
Start Here
When working in this repository:
- Read
SKILL.mdfirst. - Read only the supporting files needed for the current task.
- Preserve the Skill as portable Markdown + supporting resources rather than coupling it to one proprietary command surface.
Supporting files currently include:
RESEARCH_RULES.md— evidence, claims, figures, equations, and citation integrity.STYLE_PRESETS.md— safe academic visual systems and fallback directions.research-template-pack/selection-index.json— lightweight metadata for distinctive research templates.research-template-pack/templates/<slug>/preview.md— lightweight preview recipe; read only for shortlisted candidates.research-template-pack/templates/<slug>/design.md— full selected design system; read only after a direction is chosen.SLIDE_SYSTEM.md— research narrative and slide composition rules.viewport-base.css— mandatory 1920×1080 fixed-stage CSS.html-template.md— canonical HTML/controller architecture.animation-patterns.md— research-specific motion guidance.scripts/validate_slides.py— deterministic structural validation before visual review.examples/— demonstrations and test cases.assets/style-gallery/— human-facing gallery assets only; do not load them as runtime design specifications.
Product Direction
The project should solve this job:
Given a paper, research notes, data, or an existing research deck, produce a clear, visually strong presentation while preserving scientific traceability.
The key differentiator is not generic slide generation. It is the combination of:
- research narrative design
- claim/source traceability
- figure- and equation-aware presentation
- progressive visual discovery
- fixed-stage HTML output
- structural and visual validation
Codex Development Rules
1. Prefer executable guidance over vague prose
When improving the Skill, write instructions that Codex can actually follow:
- identify inputs
- define ordered steps
- specify output artifacts
- define failure conditions
- define validation checks
Avoid advice such as “make it professional” without concrete implementation rules.
2. Use progressive disclosure
Keep SKILL.md as the workflow entry point.
Move detailed material into support files when it would otherwise make the main Skill unnecessarily large. SKILL.md should explicitly say when each support file must be read.
For visual discovery specifically:
- read
selection-index.jsonfirst; - shortlist using metadata;
- read only shortlisted
preview.mdfiles; - generate real user-content previews;
- after selection, read exactly the selected
design.mdunless the user explicitly requests a mixed system.
Do not preload every template design file.
3. Keep the core Skill portable
Do not require Claude Code-specific commands, marketplace manifests, or .claude-plugin files.
Do not assume one IDE or one Codex client unless the feature truly requires it.
If a Codex-specific capability is added, document a portable fallback where practical.
4. Preserve scientific integrity
Never introduce fabricated citations, numbers, experimental results, equations, or figure attributions into examples or generated assets.
When a demo uses a real paper or dataset, keep a claim/source map or equivalent traceability artifact.
5. Treat examples as tests
Examples should exercise the Skill rather than act as decoration.
A good example should demonstrate several of the following:
- source extraction
- narrative restructuring
- visual style discovery
- equations
- figures or diagrams
- quantitative results
- citations
- limitations
- final HTML rendering
6. Fixed stage is non-negotiable
Generated decks use a 1920×1080 stage and scale uniformly to the viewport.
Do not convert slides into responsive webpages that reflow at mobile widths.
Use viewport-base.css as the canonical stage behavior.
7. Validate after changes
For HTML presentation changes, verify at least:
- slide count
- navigation
- 16:9 stage scaling
- no clipped content
- no panel overlap
- readable citations/source labels
- no broken local assets
Run python scripts/validate_slides.py <presentation.html> when a local checkout is available, then perform rendered visual review separately.
For Skill changes, verify:
- YAML frontmatter remains valid
- the trigger description still matches the actual job
- every referenced support file exists
- the workflow has a clear input → process → output path
- no contradictory instructions exist across support files
- progressive-disclosure rules still prevent loading every full design system up front
Repository Hygiene
- Keep names descriptive and stable.
- Avoid duplicate copies of large instructions unless packaging requires them.
- Prefer small scripts that validate or transform artifacts over large framework dependencies.
- Do not add a build system unless it clearly improves the Skill workflow.
- Do not add a framework just to make the demo look more sophisticated.
- Keep human-facing gallery assets separate from agent runtime instructions.
Near-Term Priorities
Unless a user task overrides this order, prioritize:
- Codex-usable Skill quality.
- Strong visual discovery and selected-template execution.
- Supporting HTML architecture and validation rules.
- Research extraction / verification utilities.
- Strong examples that test the Skill.
- Distribution and showcase polish after the workflow remains reliable.
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.

