Add a TechDocs site for recurring-events #63

Closed
opened 2026-11-21 23:00:24 +00:00 by martin · 1 comment
Owner

Summary

Add repository-owned documentation for the recurring-events service that Backstage can build and publish through TechDocs.

Context

The repository owns the OpenAPI contract and now has a Backstage Component descriptor, but it does not yet provide a TechDocs site. Personal/backstage#25 coordinates the portal integration and hosted publishing/access plan.

Scope

  • Add an MkDocs configuration and concise documentation for the service/API.
  • Add the TechDocs catalog annotation to the recurring-events Component.
  • Provide a reproducible Nix development-shell build and local preview command.
  • Document how to author docs, preview them locally and in Backstage, and troubleshoot common build/import failures.
  • Do not change the OpenAPI contract or API runtime as part of this documentation work.

Acceptance criteria

  • just docs builds the documentation successfully from this repository.
  • The Component points TechDocs at the repository docs source with backstage.io/techdocs-ref.
  • just docs-serve previews the documentation locally, and the README explains authoring, preview, and troubleshooting.
  • Documentation contains no credentials or private values.
  • Personal/backstage#25 verifies TechDocs rendering/search and records the hosted CI/storage and private-document access approach.
## Summary Add repository-owned documentation for the recurring-events service that Backstage can build and publish through TechDocs. ## Context The repository owns the OpenAPI contract and now has a Backstage Component descriptor, but it does not yet provide a TechDocs site. Personal/backstage#25 coordinates the portal integration and hosted publishing/access plan. ## Scope - Add an MkDocs configuration and concise documentation for the service/API. - Add the TechDocs catalog annotation to the recurring-events Component. - Provide a reproducible Nix development-shell build and local preview command. - Document how to author docs, preview them locally and in Backstage, and troubleshoot common build/import failures. - Do not change the OpenAPI contract or API runtime as part of this documentation work. ## Acceptance criteria - [ ] `just docs` builds the documentation successfully from this repository. - [ ] The Component points TechDocs at the repository docs source with `backstage.io/techdocs-ref`. - [ ] `just docs-serve` previews the documentation locally, and the README explains authoring, preview, and troubleshooting. - [ ] Documentation contains no credentials or private values. ## Related - Personal/backstage#25 verifies TechDocs rendering/search and records the hosted CI/storage and private-document access approach.
Author
Owner

Duplicate of Personal/recurring-events#65, which is the canonical TechDocs source issue and is now complete. This issue was created unintentionally during setup; its source work and follow-up are tracked in #65 and Personal/backstage#25.

Duplicate of Personal/recurring-events#65, which is the canonical TechDocs source issue and is now complete. This issue was created unintentionally during setup; its source work and follow-up are tracked in #65 and Personal/backstage#25.
Sign in to join this conversation.
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.

Reference
Personal/recurring-events#63
No description provided.