agentreadme

Report · marked 25 Aug 2026

inkonchain/docs

An agent will struggle here, mostly for fixable reasons.

MDX · 36,520 stars · 156 files · branch main

52 /100 C+
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 10/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 test command is discoverable.Context economy 20/20Whether the repo fits in a context window, or fights it. Full marks.Navigability 4/10How quickly anything new can orient itself. Losing marks on written documentation and repository description.

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
Tests exist
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.

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
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 (dev, build, postbuild, start, lint, lint:fix…)
✗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
dockerfile gives a known-good environment.
Verification loop 10/25 C

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

✗Tests exist 0/8
No test files found. An agent has no way to know whether its change broke anything.
This is the single highest-leverage change on this page. Agents don't need full coverage, they need one command that goes red when they break something. Even a handful of tests on the core path converts blind editing into a feedback loop.
✗Test command is discoverable 0/7
There's no obvious way to run the tests. Even if tests exist, an agent won't reliably find the entry point.
Add a `test` script or a `test` target that runs the whole suite with no arguments. The convention is the interface — an agent tries `npm test` and `make test` before it tries reading your CI config.
✓Continuous integration 4/4
2 GitHub Actions workflows define what "passing" means.
✓Lint and format rules 3/3
eslint.config.js encodes the house style.
✓Static type checking 3/3
Strict type checking is on, which catches a whole class of agent mistakes before they run.
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 8 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 23.3MB 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 inkonchain/docs 
# AGENTS.md

Ink Documentation

## Setup

```
pnpm install
```

## Commands

```
pnpm dev           # run locally
pnpm start         # run the app
pnpm build         # produce a build
pnpm lint          # lint
pnpm postbuild
pnpm lint:fix
pnpm lint:js
pnpm lint:js:fix
```

## Layout

- `src/` 29 source files

## Conventions

- There are no tests yet. An agent has no way to check its own work here.
- 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/cicd.yaml`, 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/inkonchain/docs.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 52 out of 100

[![agent ready](https://agentreadme.com/badge/inkonchain/docs.svg)](https://agentreadme.com/inkonchain/docs)

Other MDX repositories, marked

twbs/bootstrap 61 B- dair-ai/Prompt-Engineering-Guide 61 B- thedaviddias/Front-End-Checklist 85 A

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