Project documents and milestones

A project’s documentation lives in its repository, as Markdown. Pitwall reads it from its own copy of the repository, fetched from GitHub every minute, and never edits it: a change to a document is a commit, like any other.

Docs

On the project’s page, Docs shows the Markdown of its repository as a tree, each document rendered, with its own address.

• A link to another document opens inside Pitwall.
• / filters the tree.
• A− and A+ set the text size.

Nothing is edited here.

Milestones

For a repository planned in milestones, the project’s page shows each milestone with its phases and their state, read from the repository’s own files. A milestone’s name opens its file in Docs.

The view reads a layout of files — a progress file and a folder of milestone specs — that is not yet described on this site. Until it is, a repository without that layout shows no milestones; nothing else depends on it.

What each step wrote

Every step leaves its files under docs/tickets/<KEY-N>/ on the ticket’s branch: the spec and its plan, the acceptance criteria, what changed, the manual test script and its results. On the ticket, the document button on a step’s card opens what it wrote, rendered in a panel beside the page, which can be maximized. A file an agent cites in a question opens the same way.

These files stay in the repository after the merge, so the record of how a change was made is kept with the change.

The repositories

The project’s page lists each repository with its last commit and the CI of its default branch, and says why Pitwall cannot reach one when it cannot (Connecting GitHub).