docs: document TechDocs pilot and verification #61

Merged
martin merged 1 commit from feat/techdocs-pilot into main 2026-11-22 11:14:35 +00:00
Owner

Summary

Document the TechDocs pilot and add isolated browser coverage for the TechDocs reader.

Changes

  • Document the recurring-events pilot, Gitea tree-reference requirement, local generator/publisher config, render/search verification, authoring, and troubleshooting.
  • Record the CI publishing, private object-storage, credential-boundary, and access-control approach for a hosted portal.
  • Add a controlled fixture annotation and browser test for rendering a TechDocs page without live Forgejo or Docker dependencies.

Verification

  • bun run tsc
  • bun run prettier:check
  • CI=1 ... bun run test:e2e: 7/7 passed using the controlled catalog fixtures.
  • Separately synced the merged recurring-events pilot through Backstage with a local MkDocs generator overlay; the TechDocs pages and metadata returned HTTP 200, and the TechDocs search query returned 12 results for recurring events.

The configured Docker generator was not changed. This PR does not enable private documentation; the hosted authorization policy remains dependent on #30.

Refs: #25

## Summary Document the TechDocs pilot and add isolated browser coverage for the TechDocs reader. ## Changes - Document the recurring-events pilot, Gitea tree-reference requirement, local generator/publisher config, render/search verification, authoring, and troubleshooting. - Record the CI publishing, private object-storage, credential-boundary, and access-control approach for a hosted portal. - Add a controlled fixture annotation and browser test for rendering a TechDocs page without live Forgejo or Docker dependencies. ## Verification - `bun run tsc` - `bun run prettier:check` - `CI=1 ... bun run test:e2e`: 7/7 passed using the controlled catalog fixtures. - Separately synced the merged recurring-events pilot through Backstage with a local MkDocs generator overlay; the TechDocs pages and metadata returned HTTP 200, and the TechDocs search query returned 12 results for `recurring events`. The configured Docker generator was not changed. This PR does not enable private documentation; the hosted authorization policy remains dependent on #30. Refs: #25
docs: document TechDocs pilot and verification
All checks were successful
ci/woodpecker/pr/pr-review Pipeline was successful
ci/woodpecker/pr/application-checks Pipeline was successful
5c4c6d44e9
Explain the pilot configuration, troubleshooting, and hosted publishing
and access controls. Add controlled TechDocs fixture coverage so the
reader integration is tested without live Forgejo or Docker access.

Refs: Personal/backstage#25

Co-authored-by: OpenCode <opencode@anoma.ly>
martin merged commit 1855476dc0 into main 2026-11-22 11:14:35 +00:00
martin deleted branch feat/techdocs-pilot 2026-11-22 11:14:35 +00:00
Sign in to join this conversation.
No description provided.