agentleFS
vojtaholikvojtaholik/smer/.agents/skills/lat-md/SKILL.md

lat-md

Skill1 starsChanged 4 months agoMITView on GitHub

Writing and maintaining lat.md documentation files — structured markdown that describes a project's architecture, design decisions, and test specs. Use when creating, editing, or reviewing files in the lat.md/ directory.

6 other projects use a version of this, 4 of them edited.

Adopted by

Most recently taken up by

  • Other versions6 projects use a version of this.

    Word for word · 1

    1. fathah/hermes-desktop★ 15k100% same

    Edited · 4

    1. vercel-labs/lat.md★ 2.1k52% same
    2. vercel/vercel-py★ 3452% same
    3. vercel-labs/notebook-factory★ 461% same
    4. vercel-labs/ggbuild★ 276% same

    Wrote their own version · 1

    1. nubjs/nub★ 4.4ksame name

    How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.

  • In this repository2 other files it gives its agents.

The file

We split this skill into the rules it gives an agent

8 rules. 5 are common, 0 are distinctive, and 3 are very specific to this project.

  • 5

    Common

    Most of the 5 edited versions we read keep these.

  • 0

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Common:

    Test specifications (what is tested and why)

    line 21
  2. Common:

    Every section must have a leading paragraph — at least one sentence immediately after the heading, before any child headings or other block …

    line 31
  3. Very specific:

    Place one @lat: comment per section, at the relevant code — not at the top of the file.

    line 109
  4. Very specific:

    Every leaf section under require-code-mention: true must be referenced by exactly one @lat: comment

    line 146
  5. Common:

    Every section MUST have a description — at least one sentence explaining what the test verifies and why

    line 147
  6. Very specific:

    Always run lat check after editing lat.md/ files.

    line 165
  7. Common:

    All wiki links point to existing sections or source code symbols

    line 166
  8. Common:

    Every section has a leading paragraph (≤250 chars)

    line 168

“Common” is measured: kept by at least 6 in 10 of the 5 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

lat.md Authoring Guide

This skill covers the syntax, structure rules, and conventions for writing lat.md/ files. Load it whenever you need to create or edit sections in the lat.md/ directory.

What belongs in lat.md

lat.md/ files describe what the project does and why — domain concepts, key design decisions, business logic, and test specifications. They do NOT duplicate source code. Think of each section as an anchor that source code references back to.

Good candidates for sections:

  • Architecture decisions and their rationale
  • Domain concepts and business rules
  • API contracts and protocols
  • Test specifications (what is tested and why)
  • Non-obvious constraints or invariants

Bad candidates:

  • Step-by-step code walkthroughs (the code itself is the walkthrough)
  • Auto-generated API docs (use tools for that)
  • Temporary notes or TODOs

Section structure

Every section must have a leading paragraph — at least one sentence immediately after the heading, before any child headings or other block content.

The first paragraph must be ≤250 characters (excluding [[wiki link]] content). This paragraph is the section's identity — it appears in search results, command output, and RAG context.

# Good Section

Brief overview of what this section documents and why it matters.

More detail can go in subsequent paragraphs, code blocks, or lists.

## Child heading

Details about this child topic.
# Bad Section

## Child heading

This is invalid — "Bad Section" has no leading paragraph.

lat check enforces this rule.

Section IDs

Sections are addressed by file path and heading chain:

  • Full form: lat.md/path/to/file#Heading#SubHeading
  • Short form: file#Heading#SubHeading (when the file stem is unique)

Examples: lat.md/tests/search#RAG Replay Tests, cli#init, parser#Wiki Links.

Wiki links

Cross-reference other sections or source code with [[target]] or [[target|alias]].

Section links

See [[cli#init]] for setup details.
The parser validates [[parser#Wiki Links|wiki link syntax]].

Source code links

Reference functions, classes, constants, and methods in source files:

[[src/config.ts#getConfigDir]]          — function
[[src/server.ts#App#listen]]            — class method
[[lib/utils.py#parse_args]]             — Python function
[[src/lib.rs#Greeter#greet]]            — Rust impl method
[[src/app.go#Greeter#Greet]]            — Go method
[[src/app.h#Greeter]]                   — C struct

lat check validates that all targets exist.

Code refs

Tie source code back to lat.md/ sections with @lat: comments:

// @lat: [[cli#init]]
export function init() { ... }
# @lat: [[cli#init]]
def init():
    ...

Supported comment styles: // (JS/TS/Rust/Go/C) and # (Python).

Place one @lat: comment per section, at the relevant code — not at the top of the file.

Test specs

Describe tests as sections in lat.md/ files. Add frontmatter to require that every leaf section has a matching @lat: comment in test code:

---
lat:
  require-code-mention: true
---
# Tests

Authentication test specifications.

## User login

Verify credential validation and error handling.

### Rejects expired tokens

Tokens past their expiry timestamp are rejected with 401, even if otherwise valid.

### Handles missing password

Login request without a password field returns 400 with a descriptive error.

Each test references its spec:

# @lat: [[tests#User login#Rejects expired tokens]]
def test_rejects_expired_tokens():
    ...

Rules:

  • Every leaf section under require-code-mention: true must be referenced by exactly one @lat: comment
  • Every section MUST have a description — at least one sentence explaining what the test verifies and why
  • lat check flags unreferenced specs and dangling code refs

Frontmatter

Optional YAML frontmatter at the top of lat.md/ files:

---
lat:
  require-code-mention: true
---

Currently the only supported field is require-code-mention for test spec enforcement.

Validation

Always run lat check after editing lat.md/ files. It validates:

  • All wiki links point to existing sections or source code symbols
  • All @lat: code refs point to existing sections
  • Every section has a leading paragraph (≤250 chars)
  • All require-code-mention leaf sections are referenced in code

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.