# unifold

> unifold 0.3 is an open standard for writing down how the parts of a repository depend on each other. A folder becomes a unit by getting a `unifold.yaml` that lists what it provides and what it needs; the unit above connects each need to a provider; a checker keeps this consistent and generates the diagrams.

All pages below are plain Markdown. The same pages exist as HTML without the `.md` ending.

## Standard

- [unifold 0.3: the standard](https://unifold.md/spec.md): The whole standard on one page: manifest, wiring, documents, what a checker guarantees.
- [JSON Schema of the manifest](https://unifold.md/0.3/unifold.schema.json): For validating `unifold.yaml`.

## Reference

- [Documents](https://unifold.md/documents.md): The files of a unit, the four kinds of knowledge, README.md, the generated AGENTS.md, the explanation files, where a file may point.
- [Writing](https://unifold.md/writing.md): How each document is written: context items, decisions, references, contracts, skills, tutorials, explanation files, the review checklist.
- [Contracts](https://unifold.md/contracts.md): The one document of a connection: parts with signatures and examples, the fake, folders, the template.
- [Agents](https://unifold.md/agents.md): How coding agents find and use unifold, per agent.
- [Tool](https://unifold.md/tool.md): The reference tool: commands, output, hooks, continuous integration.
- [Tool JSON](https://unifold.md/tool-json.md): The JSON that the reference tool prints.
- [Rules](https://unifold.md/rules.md): Every finding the reference tool reports.

## Explanation

- [Requirements](https://unifold.md/requirements.md): What the standard must achieve, for which repositories it fits, where the value is.
- [Reasoning](https://unifold.md/reasoning.md): Where the parts come from, what unifold adds, the design ideas behind it, Diátaxis and arc42.
- [Wiring](https://unifold.md/wiring.md): Wiring in practice: names, passing needs up, several children on one provider, alternatives, adapters, the kinds of units, scenarios, services.
- [Invariants](https://unifold.md/invariants.md): What is true of the standard, the skills and the tool at every moment.
- [Risks](https://unifold.md/risks.md): Risks and known limits of the standard.

## Tutorial

- [Your first map](https://unifold.md/first-map.md): A tutorial: a root manifest, two units, a connection, the first diagram, documents for one unit.

## Agents

- [The unifold skill](https://unifold.md/skill/SKILL.md): Work in a repository that contains unifold.yaml files.
- [The unifold-convert skill](https://unifold.md/skill/unifold-convert/SKILL.md): Convert an existing repository to unifold, or bring a part of one into the map.

## Optional

- [Repository](https://github.com/wackazong/unifold): The standard, the skill, the reference tool and the examples.
- [Example: plantwatch](https://unifold.md/examples/plantwatch/): the explorer of the example, its map with every document.
- [Example: serial-line](https://unifold.md/examples/serial-line/): the explorer of the example, its map with every document.
- [Example: slugline](https://unifold.md/examples/slugline/): the explorer of the example, its map with every document.