Writing documentation

This guide sets the rules for documentation in this repository. It applies to people and agents.

Style

Accuracy

Opening screen

Each document opens with what it covers, who it is for and the key idea, in under 120 words.

Terms

Before and after

A claim that cannot be checked, from the repository description:

Before: A software forge you can read in an afternoon and mold by hand.

After: Your software and the crew that builds it, in one place.

A figure of speech, from docs/ORIGINS.md:

Before: All forges share the same units, so the adapters are small and boring, which is the point.

After: Adapters are small because forges share the same units: issues, pulls, comments and labels.

An issue number and a slogan, from docs/STUDIO.md:

Before: One forge, for every viewer (#603).

After: The forge shows one interface to every viewer.

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs