# Contributing & Creating Pages

This page explains how to add documentation pages, what to include, and how to format your git commits.

Create a new page

1. Copy `docs/dam_pro/template.md` to `docs/dam_pro/my_page.md` and edit the content.
2. Keep the page focused: add a short summary, an Overview, Steps, Examples, and Links.
3. Add relative links to other docs (e.g. `[Getting Back](getting_back.md)`).
4. Add images under `docs/img/` and reference them relatively: `![alt](../img/example.png)`.
5. Update `mkdocs.yml` nav if you want the page in the top-level navigation.

Checklist before committing

- [ ] Page created from `docs/template.md` and content reviewed
- [ ] No secrets or passwords in the page
- [ ] Code blocks use fenced syntax and are tested where possible
- [ ] Added to `mkdocs.yml` nav (if navigation required)
- [ ] Built locally via `python -m mkdocs build` and verified

Git commit message template

Use the repository commit template at `.gitmessage.txt` (example below). To use it locally:

    git config --local commit.template .gitmessage.txt

Suggested commit message template (already provided in repo):

    DOCS: <short description>

    Longer description of the change and motivation (wrap at ~72 chars).

    Pages: docs/<page.md>

If you need help reviewing content or want a second pair of eyes, open a PR with the page and I'll review it.

« Previous Next »