Report · marked 25 Aug 2026

facebook/docusaurus

Solid foundations, held back in a few specific places.

TypeScript · 66,078 stars · 4,246 files · branch main

84 /100 A-

Instructions 25/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on 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 22/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on static type checking.Context economy 15/20Whether the repo fits in a context window, or fights it. Losing marks on repository weight.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

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.

Repository weight

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

Static type checking

A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

The full marking

Every deduction below names the file or setting it came from.

Instructions 25/27 A+

Whether the repo tells an agent how to behave before it starts guessing.

✓Agent instruction file 12/12

AGENTS.md is present, which is the format the most tools read.

✗Instruction quality 10/12

Specific enough that an agent can act on it.

Worth fixing: has no code blocks.

4,133 characters, a workable length

names the actual commands to run

uses headings, so an agent can skim it

✓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

pnpm-lock.yaml pins the dependency tree.

Found pnpm-lock.yaml

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

package.json scripts (start, start:website, start:website:profile, start:website:baseUrl, start:website:blogOnly, start:website:deployPreview…)

✗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 .nvmrc

✓Reproducible environment 2/2

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

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

781 test files against 1157 source files.

e.g. .github/workflows/showcase-test.yml, __tests__/validate-package-json.test.ts, __tests__/validate-tsconfig.test.ts

✓Test command is discoverable 7/7

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

✓Continuous integration 4/4

17 GitHub Actions workflows define what "passing" means.

✓Lint and format rules 3/3

eslint.config.ts encodes the house style.

✗Static type checking 0/3

No static type checking.

A type checker gives an agent an error message instead of a runtime surprise. It's the second-fastest feedback loop after the compiler.

Context economy 15/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 41 patterns.

✓File sizes fit in context 6/6

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

✗Repository weight 0/5

About 1377MB checked out. Large enough that cloning and searching are both slow.

Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.

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 facebook/docusaurus

# AGENTS.md

Easy to maintain open source documentation websites.

## Setup

```
pnpm install
```

## Commands

```
pnpm start                   # run the app
pnpm build                   # produce a build
pnpm test                    # run the test suite, must pass before any commit
pnpm lint                    # lint
pnpm format                  # format
pnpm start:website
pnpm start:website:profile
pnpm start:website:baseUrl
```

## Layout

- `packages/`  1018 source files
- `website/`   106 source files
- `admin/`     11 source files
- `examples/`  8 source files
- `test/`      5 source files
- `__tests__/` 2 source files

## Conventions

- Tests live alongside the code they cover, following `.github/workflows/showcase-test.yml`.
- CI defines what passing means. See `.github/workflows/argos.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/facebook/docusaurus.md

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/facebook/docusaurus.svg)](https://agentreadme.com/facebook/docusaurus)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 68 B nilbuild/developer-roadmap 45 C vuejs/vue 67 B n8n-io/n8n 87 A anomalyco/opencode 80 A-

All TypeScript 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