Source: https://seerepo.com/docs/wiki
Markdown source: https://seerepo.com/docs/wiki.md
Description: Your repo's documentation, a chapter per module with the shape of your code and the proof of each statement.

# Wiki

The Wiki, folder 5 in the dock, is your repo's documentation: a chapter per module, with the shape of your code and up to date with every push. Each statement carries its proof. The house in the path at the top takes you back to your project. If your Wiki isn't written yet, the page says so and takes you to your map: it's written with your next push.

![The Wiki of a repo: the chapters on the left, a chapter's text with its diagram in the middle and «On this page» on the right](/media/docs/wiki.jpg)

## What's new since your visit

Under the title, one line says how many chapters changed since your last visit, and the index marks them with a dot. It counts when a chapter's facts change; if SeeRepo only wrote it again, it doesn't. Only the owner and their members see it, each from their own visit.

## The chapters

On the left, in the same box as the other folders' menu, the chapters in your map's order: "The project" and one per module, each with its module's icon and its parts under it. On top, a search finds a chapter by its name or by what its module does. Under the tree you see the commit it's up to date with. On a phone, the tree is a picker above the text. Each chapter has its address (`?ch=2.1`), to link to it.

"The project" opens as a cover: your project in one row, with its icon, its name, what it is in a sentence and its figures, and under it its modules as folders, each with its sentence; touch one to read its chapter. The folders go in groups, as in Structure's plan: **What people open**, **What works behind it** and **The base the others use**; your data, apart. The rest of the summary, with the diagram of how it connects, waits at the end, under **Read the full summary**. That sentence is your repo's description on GitHub; when it has none, SeeRepo writes one from what your modules do, and yours takes its place the day you add it.

## Reading a chapter

On top, when it was written, like "Written Oct 31"; unfold it to see which version of your code it read. Under the first paragraphs, **How it is today** says when the module changed and how many things it has to fix, with a link to Health. A visitor of a public map only counts what they can see.

What's technical goes folded and last: **Connections**, **Data it touches** and **Recent changes**, and inside each part, its own. In **Recent changes**, each change says its day, what changed in one sentence, who made it and its key, and the list ends with a link to Journey. When a module has sub-modules, each one is a closed row with its name, what it does and how many parts it has: touch it to open it.

In the middle, the text, read going down. Another chapter's name, where the text cites it, is the link to that chapter. The small chips are its proofs in the code: **timing.ts 1–16** opens that part's sheet on the map; with ⌘ or Ctrl, the file on GitHub, at the commit it was written with. When two files share a name, the chip carries its folder too. **Files of this chapter** lists them all. On the right, on wide screens, **On this page** lists the sections with a name of their own and takes you to each one.

A chapter is written by the engine from your code's facts. With a plan, AI writes its first paragraph from those same facts, and a sentence without its proof is dropped. A part nothing in your product uses says so, with the same rule as Health, and one copied from a kit (shadcn, Catalyst) says it's copied, not yours. A chapter tells up to 100 parts in detail: when its module has more, the sections that don't fit go at the end in a line each, with their sentence and how many parts they have, and their detail stays in the map. If a push arrives while you read, the text stays where you were; if that chapter changed, a strip says so and lets you see the new version.

## The diagrams

Each chapter shows how its module connects, drawn from your map's cables. The page shows at most the seven most used pieces, so it reads without enlarging it; **See it large** opens the whole one, at its own size and with a scrollbar to move around. In the page, a box that has somewhere to go takes you to its section or its chapter.

## On the free plan

You see the whole tree and read "The project". The other chapters come with a plan: pick any one with a lock, in the tree, on the cover or under "Next", and the plans open. At the end of the cover, a note says how many chapters you read and how many a plan opens. A repo read at its first level only has no chapters yet: the Wiki says so, with the button to the plans.

## On your public map

If your map is public, whoever visits it reads the Wiki, without Pages' and Journey's sections. Search engines don't keep it yet.