Report · marked 9 Oct 2026

siyuan-note/siyuan

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

TypeScript · 46,686 stars · 4,846 files · branch master

63 /100 B

Instructions 23/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality.Setup 10/20Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and environment config.Verification loop 12/25Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on test command is discoverable and lint and format rules.Context economy 9/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability 10/10How quickly anything new can orient itself. Full marks.

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

Fix these first

Test command is discoverable

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.

Deterministic install

Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.

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 23/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 8/12

Real instructions, with gaps.

Worth fixing: it's 26k characters, which burns context on every single turn; has no code blocks.

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 10/20 C+

Whether an agent can install the project and get it running without a human.

✗Deterministic install 0/6

No lockfile. An agent installing dependencies may not get what CI got.

Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.

✓Discoverable commands 6/6

Commands are declared where an agent will look for them.

scripts/ directory

✗Environment config 2/4

Env vars are mentioned in the README but there's no example file to copy.

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

dockerfile gives a known-good environment.

Verification loop 12/25 C+

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

✓Tests exist 8/8

1267 test files against 3035 source files.

e.g. app/electron/accessibility.test.js, app/electron/appMenu.test.js, app/electron/bootWindow.test.js

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

✓Continuous integration 4/4

6 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 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 9/20 C

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

✗File sizes fit in context 0/6

33 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.

app/stage/protyle/js/mathjax/tex-svg-full.js — 1769KB

app/stage/protyle/js/graphviz/viz.js — 1358KB

app/stage/protyle/js/pdf/pdf.worker.min.mjs — 1338KB

✗Repository weight 0/5

About 800MB 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 siyuan-note/siyuan

# AGENTS.md

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间，让人与智能体在此协作

## Setup

```
# TODO: the install command. No lockfile was found, so this could not be inferred.
```

## Commands

```
# TODO: nothing declares a build or test command, so an agent has to guess.
# This is the single most valuable section of this file. Fill it in.
```

## Layout

- `app/`     1544 source files
- `kernel/`  1467 source files
- `scripts/` 24 source files

## Conventions

- Tests live alongside the code they cover, following `app/electron/accessibility.test.js`.
- CI defines what passing means. See `.github/workflows/auto_aur_release_stable.yml`, and keep it green.
- TODO: add the two or three conventions a newcomer always gets wrong here.

## Gotchas

- `app/stage/protyle/js/mathjax/tex-svg-full.js` is 1769KB. It will not fit comfortably in context, so read it in parts.
- No lockfile is committed, so an install here may not match what CI produced.

---

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/siyuan-note/siyuan.md

A draft gets the commands right and stops at the things only a maintainer knows. What a good TypeScript AGENTS.md looks like covers what to add by hand, and 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/siyuan-note/siyuan.svg)](https://agentreadme.com/siyuan-note/siyuan)

Other TypeScript repositories, marked

freeCodeCamp/freeCodeCamp 69 B openclaw/openclaw 73 B+ nilbuild/developer-roadmap 45 C deepseek-ai/deepseek-harness 82 A- vuejs/vue 67 B anomalyco/opencode 78 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