docs: add TechDocs site for recurring-events #66

Merged
martin merged 1 commit from feat/recurring-events-techdocs into main 2026-11-22 10:39:06 +00:00
Owner

Summary

Add a repository-owned TechDocs site for the recurring-events API and point the Backstage Component at it.

Changes

  • Add mkdocs.yml and concise docs/ pages for the service, API, and development/documentation workflow.
  • Add just docs (strict build) and just docs-serve (local preview on port 8001).
  • Include mkdocs in the Nix development shell and ignore the generated site/ directory.
  • Annotate the Component with backstage.io/techdocs-ref: dir:..
  • Document hosted CI publishing, private storage, and access-control requirements without adding credentials.

Verification

  • nix develop --command just docs builds successfully with mkdocs build --strict.
  • nix fmt reports no changes.
  • Closes #65
  • Personal/backstage#25 verifies Backstage rendering/search and records the hosted publishing and access plan.
## Summary Add a repository-owned TechDocs site for the recurring-events API and point the Backstage Component at it. ## Changes - Add `mkdocs.yml` and concise `docs/` pages for the service, API, and development/documentation workflow. - Add `just docs` (strict build) and `just docs-serve` (local preview on port 8001). - Include `mkdocs` in the Nix development shell and ignore the generated `site/` directory. - Annotate the Component with `backstage.io/techdocs-ref: dir:.`. - Document hosted CI publishing, private storage, and access-control requirements without adding credentials. ## Verification - `nix develop --command just docs` builds successfully with `mkdocs build --strict`. - `nix fmt` reports no changes. ## Related - Closes #65 - Personal/backstage#25 verifies Backstage rendering/search and records the hosted publishing and access plan.
docs: add TechDocs site for the service
All checks were successful
ci/woodpecker/pr/pr-review Pipeline was successful
ci/woodpecker/pr/verify-nix Pipeline was successful
f3336e3a41
Add an MkDocs source with API and development guidance, a strict local
build and preview command, and the TechDocs catalog annotation. Include
hosted publishing and private-access guidance for the portal rollout.

Refs: Personal/recurring-events#65

Co-authored-by: OpenCode <opencode@anoma.ly>
martin merged commit 7e884cfcf5 into main 2026-11-22 10:39:06 +00:00
martin deleted branch feat/recurring-events-techdocs 2026-11-22 10:39:06 +00:00
Sign in to join this conversation.
No description provided.