# Writing And Building Docs

> Writing And Building Docs is an Agent Skill for documents published in the aiidateam/aiida-core repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when writing, editing, or building documentation files (`.md`, `.rst`) under `docs/`.

- Skill name: `writing-and-building-docs`
- Category: [Documents](https://www.openparable.com/skill/documents/1)
- Source: https://github.com/aiidateam/aiida-core/blob/HEAD/.claude/skills/writing-and-building-docs/SKILL.md
- Repository: aiidateam/aiida-core (575 GitHub stars when collected)

## SKILL.md

# Writing and building documentation for aiida-core

When writing or editing `.md` or `.rst` files under `docs/`:

- Write **one sentence per line** (no manual line wrapping): makes diffs easy to review.
- File/directory names: alphanumeric, lowercase, underscores as separators.
- Headers in **sentence case** (e.g., "Entry points", not "Entry Points").
- Documentation follows the [Divio documentation system](https://www.divio.com/blog/documentation/): tutorials (learning-oriented), how-to guides (goal-oriented), topics (understanding-oriented), reference (information-oriented).

## Building the docs

```bash
uv run sphinx-build -b html docs/source docs/build/html
```

For live-reloading during development, use `sphinx-autobuild` (not a project dependency, install manually):

```bash
uv pip install sphinx-autobuild
uv run sphinx-autobuild docs/source docs/build/html
```

---

Source: https://www.openparable.com/skill/documents/writing-and-building-docs (OpenParable). Cite the canonical URL above.