Report · marked 10 Oct 2026

freeCodeCamp/devdocs

An agent can work here, but it will waste turns finding its footing.

Ruby · 39,541 stars · 1,977 files · branch main

67 /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 16/20Whether an agent can install the project and get it running without a human. Losing marks on environment config.Verification loop 19/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on tests exist and lint and format rules.Context economy 20/20Whether the repo fits in a context window, or fights it. Full marks.Navigability 10/10How quickly anything new can orient itself. Full marks.

Higher is better. Accent marks what is costing you most.

Fix these first

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.

Instruction quality

Instructions earn their keep by naming exact commands. 'Run the tests with `pnpm test`' beats three paragraphs of philosophy.

Environment config

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.

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 16/20 A-

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 (test, typecheck)

✗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 2/2

The language runtime version is pinned.

Found .tool-versions

✓Reproducible environment 2/2

.devcontainer/devcontainer.json gives a known-good environment.

Verification loop 19/25 B+

Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.

✗Tests exist 6/8

58 test files against 985 source files.

e.g. test/app_test.rb, test/assets/doc_cache_test.js, test/assets/doc_version_test.js

✓Test command is discoverable 7/7

An agent can find and run `npm run test`.

✓Continuous integration 4/4

4 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 2/3

Type checking is configured, but not in strict mode.

Turn on `"strict": true`. Type errors are the fastest feedback an agent gets, and non-strict mode silently discards most of them.

Context economy 20/20 A+

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 18 patterns.

✓File sizes fit in context 6/6

No source file is large enough to crowd out a context window.

✓Repository weight 5/5

About 33.5MB 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 — drafted for freeCodeCamp/devdocs

# AGENTS.md

API Documentation Browser

## Setup

```
npm ci
```

## Commands

```
npm run test        # run the test suite, must pass before any commit
npm run typecheck   # type check without emitting
```

## Layout

- `lib/`    849 source files
- `assets/` 84 source files
- `test/`   52 source files

## Conventions

- Tests live alongside the code they cover, following `test/app_test.rb`.
- TypeScript is not in strict mode. Turning it on catches a whole class of mistakes before they run.
- CI defines what passing means. See `.github/workflows/deploy-heroku.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

---

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/freeCodeCamp/devdocs.md

A draft gets the commands right and stops at the things only a maintainer knows. what AGENTS.md is explains the format itself.

Show the mark

The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.

[![agent ready](https://agentreadme.com/badge/freeCodeCamp/devdocs.svg)](https://agentreadme.com/freeCodeCamp/devdocs)

Other Ruby repositories, marked

rails/rails 66 B maybe-finance/maybe 85 A jekyll/jekyll 50 C+ mastodon/mastodon 67 B huginn/huginn 58 B- Homebrew/brew 60 B-

All Ruby repositories

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.

Open an issue, already filled in