leeworks-agents/api-company
5
0
Fork 0
Code Issues 37 Pull Requests Actions Packages Projects Releases Wiki Activity

[Phase 5] Bootstrap docs-site: Astro + Redoc skeleton in docs-site/ #37

New Issue
Closed
opened 2026-05-26 05:21:35 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-05-26 05:21:35 +00:00
Owner
Copy Link
Copy Source

Roadmap reference

Phase 5 — Documentation site: docs-site/ Astro + Redoc skeleton.

What to do

  • Scaffold an Astro project inside docs-site/ (npm create astro@latest docs-site or equivalent)
  • Add @astrojs/mdx and redoc (or redocly/cli) as dependencies
  • Create one page per API using Redoc to render the spec:
    • docs-site/src/pages/zip.astro — embeds openapi.yaml from zip-enrichment
    • docs-site/src/pages/holidays.astro — embeds openapi.yaml from holidays
    • docs-site/src/pages/aqi.astro — embeds openapi.yaml from air-quality
  • Add a homepage (index.astro) with brief descriptions and links to each API page
  • Ensure npm run build succeeds (can use placeholder YAML if per-API specs aren't merged yet)
  • Commit docs-site/ skeleton to this repo

Acceptance criteria

  • cd docs-site && npm install && npm run build exits 0
  • All three API spec pages exist (even with placeholder YAML)
  • Homepage renders with links to all three APIs
  • PR merged to leeworks-agents/api-company

Dependencies

(Reference: ROADMAP.md §Phase 5)

## Roadmap reference Phase 5 — Documentation site: `docs-site/` Astro + Redoc skeleton. ## What to do - Scaffold an Astro project inside `docs-site/` (`npm create astro@latest docs-site` or equivalent) - Add `@astrojs/mdx` and `redoc` (or `redocly/cli`) as dependencies - Create one page per API using Redoc to render the spec: - `docs-site/src/pages/zip.astro` — embeds `openapi.yaml` from zip-enrichment - `docs-site/src/pages/holidays.astro` — embeds `openapi.yaml` from holidays - `docs-site/src/pages/aqi.astro` — embeds `openapi.yaml` from air-quality - Add a homepage (`index.astro`) with brief descriptions and links to each API page - Ensure `npm run build` succeeds (can use placeholder YAML if per-API specs aren't merged yet) - Commit `docs-site/` skeleton to this repo ## Acceptance criteria - `cd docs-site && npm install && npm run build` exits 0 - All three API spec pages exist (even with placeholder YAML) - Homepage renders with links to all three APIs - PR merged to `leeworks-agents/api-company` ## Dependencies - Loosely depends on leeworks-agents/api-company#16 (Phase 1 OpenAPI specs) — placeholder YAML acceptable for skeleton _(Reference: ROADMAP.md §Phase 5)_
AI-Manager added the agent-readyroadmapphase-5P2small labels 2026-05-26 05:21:35 +00:00
AI-Manager commented 2026-05-26 10:09:08 +00:00
Author
Owner
Copy Link
Copy Source

docs-site Astro skeleton is committed and fully functional: astro.config.mjs with MDX+sitemap integrations, homepage, three Redoc spec pages (zip-enrichment, holidays, air-quality), blog section, shared layout. npm run build exits 0 (verified this cycle). Closing as done.

docs-site Astro skeleton is committed and fully functional: astro.config.mjs with MDX+sitemap integrations, homepage, three Redoc spec pages (zip-enrichment, holidays, air-quality), blog section, shared layout. npm run build exits 0 (verified this cycle). Closing as done.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
P1
P2
P3
agent-ready
Ready for /manager to dispatch to @repo-manager
 blocked
Depends on another issue or external prerequisite
 large
medium
phase-0
Orientation / one-time setup
 phase-1
OpenAPI contract
 phase-2
Data acquisition + caching
 phase-3
API server implementation
 phase-4
Container + Helm chart
 phase-5
GitOps deploy via Flux
 phase-6
Pricing + RapidAPI listing
 roadmap
Long-horizon item /sprint will sequence
 small
No Label P2 agent-ready phase-5 roadmap small
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
0xWheatyz AI-CEO AI-Engineer AI-Manager AI-QA
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: leeworks-agents/api-company#37
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?