Add MkDocs documentation site #35

New issue

Closed

opened 2026-05-24 10:10:31 +00:00 by coding-agent-marvin8 · 1 comment

coding-agent-marvin8 commented

2026-05-24 10:10:31 +00:00

(Migrated from codeberg.org)

Fedinesia has no dedicated documentation site. A user-facing docs site would provide a better experience than pointing at the README on Codeberg.

The site will be published at https://marvinsmastodontools.codeberg.page/fedinesia/ via Codeberg Pages.

Fedinesia has no dedicated documentation site. A user-facing docs site would provide a better experience than pointing at the README on Codeberg. The site will be published at https://marvinsmastodontools.codeberg.page/fedinesia/ via Codeberg Pages.

coding-agent-marvin8 commented

2026-05-24 10:11:00 +00:00

(Migrated from codeberg.org)

Exploration findings

Documentation tool: MkDocs + Material theme + Mike (version management), following the same pattern used by longwei in this org.
Deployment: Woodpecker CI publishes to the pages branch on tag events via mike deploy.
Dependency group: A docs group will be added to pyproject.toml (mkdocs, mkdocs-material, mike).
docs_hooks.py: Shared hook that updates copyright year at build time (Brisbane timezone).

Plan of attack

Add docs dependency group to pyproject.toml; update Documentation URL.
Add mkdocs.yml and docs_hooks.py (mirrored from longwei).
Create docs/ with four pages: index, getting-started, configuration, container.
Add .woodpecker/publish-docs.yml CI pipeline.
Tick off TODO item in TODO.md.
Verify: uv run mkdocs build --strict.

Branch: feat/issue-35-add-docs

## Exploration findings - **Documentation tool**: MkDocs + Material theme + Mike (version management), following the same pattern used by longwei in this org. - **Deployment**: Woodpecker CI publishes to the `pages` branch on tag events via `mike deploy`. - **Dependency group**: A `docs` group will be added to `pyproject.toml` (mkdocs, mkdocs-material, mike). - **docs_hooks.py**: Shared hook that updates copyright year at build time (Brisbane timezone). ## Plan of attack 1. Add `docs` dependency group to `pyproject.toml`; update Documentation URL. 2. Add `mkdocs.yml` and `docs_hooks.py` (mirrored from longwei). 3. Create `docs/` with four pages: index, getting-started, configuration, container. 4. Add `.woodpecker/publish-docs.yml` CI pipeline. 5. Tick off TODO item in `TODO.md`. 6. Verify: `uv run mkdocs build --strict`. Branch: `feat/issue-35-add-docs`