Report · marked 26 Aug 2026
hakimel/reveal.js
An agent can work here, but it will waste turns finding its footing.
JavaScript · 72,192 stars · 229 files · branch master
58
/100
B-
Instructions
3/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on agent instruction file and instruction quality.Setup
12/20Whether an agent can install the project and get it running without a human. Losing marks on environment config and pinned runtime version.Verification loop
22/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy
14/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context.Navigability
8/10How quickly anything new can orient itself. Losing marks on written documentation.
Higher is better. Accent marks what is costing you most.
Fix these first
01
Agent instruction file
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
02
Instruction quality
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
03
File sizes fit in context
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
The full marking
Every deduction below names the file or setting it came from.
Instructions 3/27 F
Whether the repo tells an agent how to behave before it starts guessing.
✗Agent instruction file
0/12
None found. Every agent that opens this repo starts from zero.
Add an AGENTS.md at the root: what the project is, how to install, how to run, how to test, and the two or three conventions a newcomer always gets wrong.
Looked for AGENTS.md, CLAUDE.md, .github/copilot-instructions.md, .cursorrules
✗Instruction quality
0/12
Nothing to judge, since there are no instructions.
Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.
✓README as an entry point
3/3
README has a clear getting-started section.
Setup 12/20 B-
Whether an agent can install the project and get it running without a human.
✓Deterministic install
6/6
package-lock.json pins the dependency tree.
Found package-lock.json
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
package.json scripts (dev, start, prepack, build:core, build:es5, build:styles…)
scripts/ directory
✗Environment config
0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
✗Pinned runtime version
0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
✗Reproducible environment
0/2
No container or devcontainer definition.
A Dockerfile or devcontainer removes an entire class of 'it won't install' failures.
Verification loop 22/25 A
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
29 test files against 115 source files.
e.g. react/src/__tests__/setup.ts, react/src/components/code.test.tsx, react/src/components/deck.test.tsx
✓Test command is discoverable
7/7
An agent can find and run `npm run test`.
✓Continuous integration
4/4
2 GitHub Actions workflows define what "passing" means.
✗Lint and format rules
0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
✓Static type checking
3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
Context economy 14/20 B+
Whether the repo fits in a context window, or fights it.
✓No committed build output
6/6
No generated directories committed.
✓.gitignore hygiene
3/3
.gitignore covers 17 patterns.
✗File sizes fit in context
0/6
4 source files are over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
dist/plugin/highlight.mjs — 1017KB
dist/plugin/highlight.js — 899KB
dist/reveal.mjs — 137KB
✓Repository weight
5/5
About 35.7MB checked out, which is comfortable.
Here is your AGENTS.md
Drafted from what is actually in this repository: the install
command from your lockfile, the commands you already declare, your real directory layout. Anything
marked TODO needs a person. Save it at the root as AGENTS.md.
# AGENTS.md The HTML Presentation Framework ## Setup ``` npm ci ``` ## Commands ``` npm run dev # run locally npm run start # run the app npm run build # produce a build npm run test # run the test suite, must pass before any commit npm run prepack npm run build:core npm run build:es5 npm run build:styles ``` ## Layout - `js/` 29 source files - `dist/` 27 source files - `plugin/` 23 source files - `react/` 23 source files - `scripts/` 5 source files - `test/` 5 source files ## Conventions - Tests live alongside the code they cover, following `react/src/__tests__/setup.ts`. - TypeScript runs in strict mode. Type errors are the fastest feedback available, so do not weaken it. - CI defines what passing means. See `.github/workflows/spellcheck.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - Generated output is committed (`build/`). Search will return the compiled copy, so edit the source, not that. - `dist/plugin/highlight.mjs` is 1017KB. It will not fit comfortably in context, so read it in parts. --- Drafted by agentreadme.com from what is in this repository. Everything marked TODO needs a human. Check it in as AGENTS.md at the root.
Open the raw markdown
or
curl -o AGENTS.md agentreadme.com/draft/hakimel/reveal.js.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/hakimel/reveal.js)Other JavaScript repositories, marked
Think this mark is wrong?
Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.