Skip to content
inseam mark: dash dot dashinseam mark: dash dot dashinseam

Inseam Docs

This is the documentation for inseam. Docs describe what the code does today, in plain language. Keep files short, on the topic their filename names, and split big topics into smaller files. Folders group related topics and follow the same descriptive naming.

Docs are written for incremental discovery: a person or an agent should be able to scan the tree at a high level and click down to exactly the page they need, without loading one giant file that covers everything.

Map

Section titled “Map”

Start here:

  • get-started.md — install a node, index something, query it, modify it.
  • cli.md — the inseam binary, command by command.
  • configuration.md — the composition file, the node’s only config.
  • glossary.md — the vocabulary, one page.

Then by area:

  • architecture/ — how the repo is laid out, the kernel, the macOS app, and doc generation.
  • indexing/ — how files become an index: the filesystem host, transforms, storage, and index upkeep.
  • finder/ — how queries work: the ranking algorithm and the operations built on it.
  • plugins/ — the two plugin kinds, validation, the registry, and custom builds.
  • crates/ — per-crate overviews, generated from each crate’s doc block.
  • skills/ — agent skills, generated from their SKILL.md sources.
  • brand/ — the brand and its assets.

The why behind these shapes — the design decisions — lives in design/, deliberately outside this tree.