Scaffold docs.leeworks.dev (Astro + Redoc) #5

Closed
opened 2026-05-18 21:20:05 +00:00 by 0xWheatyz · 3 comments
Owner

Phase 5 work. Build the docs site that renders each API's openapi.yaml via Redoc.

Layout

  • docs-site/ — Astro project
  • Gitea Actions pipeline copies apis/*/openapi.yaml into docs-site/public/specs/ at build time
  • Routes: docs.leeworks.dev/{zip-enrichment,holidays,air-quality}

Acceptance

  • Site deploys via Flux HelmRelease
  • All 3 specs render at their respective routes
  • Landing page lists APIs with status badges

(Reference: MASTER_BUILD_PROMPT.md §Phase 5)

Phase 5 work. Build the docs site that renders each API's `openapi.yaml` via Redoc. ### Layout - `docs-site/` — Astro project - Gitea Actions pipeline copies `apis/*/openapi.yaml` into `docs-site/public/specs/` at build time - Routes: `docs.leeworks.dev/{zip-enrichment,holidays,air-quality}` ### Acceptance - Site deploys via Flux HelmRelease - All 3 specs render at their respective routes - Landing page lists APIs with status badges _(Reference: MASTER_BUILD_PROMPT.md §Phase 5)_
0xWheatyz added the roadmapphase-5 labels 2026-05-18 21:20:05 +00:00
AI-Manager added the P3agent-readylarge labels 2026-05-19 00:27:49 +00:00
AI-Engineer was assigned by AI-Manager 2026-05-19 05:05:09 +00:00
Owner

Triage by @AI-Manager: Assigned to @AI-Engineer. Delegating to @senior-developer agent.

This is a complex multi-file scaffolding task: Astro project setup, Redoc integration, routing for 3 API specs, and landing page with status badges. Requires frontend expertise.

Priority: MEDIUM (Phase 5, depends on API specs being available).

**Triage by @AI-Manager**: Assigned to @AI-Engineer. Delegating to @senior-developer agent. This is a complex multi-file scaffolding task: Astro project setup, Redoc integration, routing for 3 API specs, and landing page with status badges. Requires frontend expertise. Priority: MEDIUM (Phase 5, depends on API specs being available).
Owner

[Repo Manager Triage]

Priority: P3 (Phase 5)
Delegated to: @senior-developer
Reason: Scaffold Astro + Redoc docs site. Large feature with multiple components: site structure, Redoc integration, landing page.

This issue has been triaged and is ready for the assigned agent to pick up.

**[Repo Manager Triage]** Priority: P3 (Phase 5) Delegated to: @senior-developer Reason: Scaffold Astro + Redoc docs site. Large feature with multiple components: site structure, Redoc integration, landing page. This issue has been triaged and is ready for the assigned agent to pick up.
Owner

Implemented in PR #20 (merged)

docs-site/ Astro 4 scaffold is now on main:

  • Astro 4 + MDX + sitemap
  • Dark-themed Base layout with nav, legal footer, status link
  • Landing page with API cards + in-development badges
  • Per-API Redoc viewer pages (/zip-enrichment, /holidays, /air-quality)
  • Blog index + 3 SEO blog posts with JSON-LD schema
  • Dockerfile (multi-stage: node build + nginx serve) with /health endpoint
  • Flux HelmRelease at flux/docs-site/ targeting docs.leeworks.dev

Blockers before live deployment: DNS record (#14), runner online (#3), API openapi.yaml files in each repo.

✅ **Implemented in PR #20 (merged)** docs-site/ Astro 4 scaffold is now on main: - Astro 4 + MDX + sitemap - Dark-themed Base layout with nav, legal footer, status link - Landing page with API cards + in-development badges - Per-API Redoc viewer pages (/zip-enrichment, /holidays, /air-quality) - Blog index + 3 SEO blog posts with JSON-LD schema - Dockerfile (multi-stage: node build + nginx serve) with /health endpoint - Flux HelmRelease at flux/docs-site/ targeting docs.leeworks.dev Blockers before live deployment: DNS record (#14), runner online (#3), API openapi.yaml files in each repo.
Sign in to join this conversation.
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/api-company#5