Lat Md

lat.md — nub's knowledge graph

The design and research corpus in wiki/ is a lat.md graph: cross-linked markdown, with lat check enforcing that every link and code reference still resolves. The repo root carries a lat.md symlink pointing at wiki/, because lat finds its graph by that directory name.

npm run lat:check runs the gate exactly as CI does. It is deliberately NOT a root devDependency: it pulls ~185 transitive packages, and the root npm ci runs through a Socket Firewall shim in every ci.yml test leg, where that much extra install tripped the "assert root deps actually installed" guard across the matrix.

There is no local lat binary, and only check has a script. Reach the other commands one of two ways — either npx --yes lat.md@<version> <cmd>, or install once with npm i -g lat.md@<version> and then call lat directly. Take <version> from the lat:check script in the root package.json, which is the single place it is pinned.

Use it before you design, and after you change

Read the graph first. A grep over crates/ tells you what the code does; the graph tells you why, and what was already tried and rejected. Both matter, and the second is the one you cannot recover by reading source.

Every command below except lat search is run in CI against this graph and must exit 0 — .github/workflows/lat-check.yml extracts this block and executes it, because lat check itself never reads .claude/skills/**. lat search is skipped there because it builds the 128 MB index. Section ids are real; substitute your own.

lat search "why is the user's Node spawned instead of embedded"   # semantic search, offline, no API key
lat locate "Two tiers"                                            # find a section by name
lat section "architecture#Architecture#Turning it off"            # print a section with its links
lat refs "architecture#Architecture#Composition"                  # what points AT this section
lat expand "fix [[compat-mode-tests]]"                            # resolve [[refs]] in a prompt
lat check                                                         # the gate CI runs

Three gates run it for you, cheapest first: .githooks/pre-commit when the staged changes touch wiki/ or this skill, .githooks/pre-push unconditionally (so a symbol rename that orphans a doc link is caught even though no doc was edited), and the lat-check job on pull requests to main. Both hooks warn rather than block if the checker cannot run, and both take NUB_SKIP_LAT_CHECK=1.

After a change that alters architecture, behavior, or test coverage, update the graph in the same commit and run lat check. It runs on every pull request against main, so a doc naming a symbol you just renamed fails there rather than rotting quietly. It is not a required check until someone adds it to branch protection, and a stacked pull request based on another branch does not run it at all.

Section ids and links

A section id is the file path with the .md dropped, then each heading — design/architecture#Architecture#Composition. A bare filename works when it is unique: architecture#Architecture#Composition. The path is relative to the graph directory under the name lat resolves it by, which is lat.md, so the full form lat prints in its own diagnostics is lat.md/design/architecture#…. The on-disk name is not interchangeable: research/cold-start#… and lat.md/research/cold-start#… both exit 0, while wiki/research/cold-start#… exits 1.

• Wiki link: [[target]] or [[target|alias]], pointing at a section or at a source symbol.
• Source link: [[crates/nub-core/src/node/spawn.rs#PATH_SHIM_PREFIX]] — repo-root-relative, unlike a section id, and lat check verifies the symbol exists. That example is deliberately one the graph already uses (wiki/design/architecture.md links it), so renaming the constant fails the gate rather than rotting this file.
• Code reference: // @lat: [[section-id]] in Rust, TypeScript or JavaScript; # @lat: [[section-id]] in Python. It ties an implementation or a test back to the section that specifies it.

What the gate cannot see: a path written as plain text (wiki/foo.md in a comment) and an ordinary [text](foo.md) markdown link. Only [[wiki links]] and @lat: references are validated. That blind spot is how 36 dead wiki/ paths accumulated in this repo, 21 citation sites of which had to be swept out of Rust comments by hand. If you want a reference to stay true, write it in one of the two checked forms.

Keep @lat: comments to places where the link earns its line — a subsystem entry point, or a test that covers a named spec. They are subject to nub's ordinary comment discipline: sparse and dense, never narration.

The two rules that make a section valid

1. Every heading needs a leading paragraph — one or more sentences immediately after the heading, before any child heading, list, table, or code block.
2. That paragraph is 250 characters or fewer, excluding text inside [[wiki links]]. It is the summary that lat search and lat section print, so put the substance in it and the detail in the paragraphs below.

Every directory also needs an index file named after it — wiki/research/research.md lists every document in wiki/research/, and lat check fails if one is missing.

Three nub-specific traps

• Never run bare lat init, and lat will ask you to twice. A passing run still prints Warning: No init version recorded — run lat init to set up agent hooks and configuration. — expected here, and safe to ignore. A checkout where the root lat.md symlink did not materialise fails instead with No lat.md directory found / Run `lat init` to create one. and exits 1; the fix is restoring the symlink (git checkout -- lat.md, or git config core.symlinks true on Windows), never lat init. Running it writes an instruction block into both AGENTS.md and CLAUDE.md, and in this repo CLAUDE.md is a symlink to AGENTS.md — Node writes through a symlink, so the second write lands on top of the first inside the tracked, public, Codex-shared AGENTS.md. Edit that file by hand instead.
• Never let anything create .agents/skills/. lat init puts its own skill there, and .githooks/pre-push refuses any push with a SKILL.md under that path, because a rival skill tree once drifted for weeks. This file is the skill; .claude/skills/ is the only skills directory.
• A Rust symbol inside a mod block cannot be linked. lat's Rust extractor walks only top-level items, so [[…rs#some_unit_test]] fails for the 972 #[test] functions that live in #[cfg(test)] mod tests, and for any item in an inline mod. Top-level functions, structs, enums, traits, consts, type aliases and impl methods all resolve. @lat: comments are a plain comment scan and work anywhere, including inside mod tests — so test specs are unaffected.