Administration handbook, operator content moved out of the README (#139) #146

Merged
miko merged 1 commit from feature/139-admin-handbook into development 2026-11-06 11:42:42 +01:00
Owner

Closes #139.

  • The administration handbook now has one page per topic. Administering kataba: categories, pages and the home page, the menu, settings, importing and restoring guides, backup and restore. Operating an instance: installation, Docker, configuration, sign-in and roles, updating.
  • The two "Coming soon" placeholder pages (in-app.md, operating.md) are removed. The links from the user handbook now point to the new pages.
  • The README is slimmer: Getting started, Running with Docker, Backup and restore, Configuration, Authentik and Roles are gone. In their place there are a handbook section with links, a short Docker Compose quickstart and dev setup steps under Development.
  • The release skill also bumps the version examples in the handbook (installation.md, docker.md, updating.md).
  • CHANGELOG 1.3.0 has a new entry under changed.

Checked against the code: KATABA_ADMIN_GROUP and KATABA_AUTHOR_GROUP have no default in the app. Only .env.example and Compose preset them. An empty or unset variable grants the role to no one. The handbook says so.

zensical build --strict passes, and all anchor links inside the handbook resolve.

🤖 Generated with Claude Code

Closes #139. - The administration handbook now has one page per topic. **Administering kataba:** categories, pages and the home page, the menu, settings, importing and restoring guides, backup and restore. **Operating an instance:** installation, Docker, configuration, sign-in and roles, updating. - The two "Coming soon" placeholder pages (`in-app.md`, `operating.md`) are removed. The links from the user handbook now point to the new pages. - The README is slimmer: Getting started, Running with Docker, Backup and restore, Configuration, Authentik and Roles are gone. In their place there are a handbook section with links, a short Docker Compose quickstart and dev setup steps under Development. - The release skill also bumps the version examples in the handbook (`installation.md`, `docker.md`, `updating.md`). - CHANGELOG 1.3.0 has a new entry under *changed*. Checked against the code: `KATABA_ADMIN_GROUP` and `KATABA_AUTHOR_GROUP` have no default in the app. Only `.env.example` and Compose preset them. An empty or unset variable grants the role to no one. The handbook says so. `zensical build --strict` passes, and all anchor links inside the handbook resolve. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
The administration handbook gets a page per topic: categories, pages and
the home page, the menu, settings, importing and restoring guides, backup
and restore, installation, Docker, configuration, sign-in and roles, and
updating. The README keeps a short Docker Compose quickstart and links
into the handbook instead of its own operator sections.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
miko merged commit d3e1f19d71 into development 2026-11-06 11:42:42 +01:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
MassiveDynamic/kataba!146
No description provided.