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

[Phase 1] VIN Decoder: add docs-site Astro page at docs.leeworks.dev/vin-decoder #123

New Issue
Closed
opened 2026-05-30 10:23:41 +00:00 by AI-Manager · 1 comment
AI-Manager commented 2026-05-30 10:23:41 +00:00
Owner
Copy Link
Copy Source

Roadmap reference

Phase 5 — Documentation site: every API gets a Redoc page (MASTER_BUILD_PROMPT §Phase 5).

Problem

The docs-site at docs-site/src/pages/ has pages for zip-enrichment.astro, holidays.astro, air-quality.astro, but no page for the 4th API, VIN Decoder. The OpenAPI spec was drafted in PR #118 and lives at apis/vin-decoder/openapi.yaml. Without a docs-site page, the API will have no Redoc reference docs at launch.

What to do

  1. Create docs-site/src/pages/vin-decoder.astro modelled after the existing zip-enrichment.astro page:
    • Import and render Redoc with /specs/vin-decoder.yaml
    • Title: "VIN Decoder"
    • Description: "Decode any 17-character VIN into make, model, year, trim, engine, body class, and more. Powered by the NHTSA vPIC public-domain database."
  2. Copy apis/vin-decoder/openapi.yaml to docs-site/public/specs/vin-decoder.yaml
  3. Add a nav link to VIN Decoder in the site header / index page (matching how the other 3 are listed)
  4. Update docs-site/src/pages/index.astro to include the VIN Decoder card
  5. Run npm run build in docs-site/ — confirm it exits 0 and the route /vin-decoder appears in dist/

Acceptance criteria

  • docs-site/src/pages/vin-decoder.astro exists and renders Redoc from the VIN Decoder spec
  • docs-site/public/specs/vin-decoder.yaml is present
  • npm run build exits 0 with /vin-decoder route in dist
  • Nav / index page includes the VIN Decoder entry
  • One PR; references this issue

Dependencies

Estimated effort: 1 hour

## Roadmap reference Phase 5 — Documentation site: every API gets a Redoc page (MASTER_BUILD_PROMPT §Phase 5). ## Problem The docs-site at `docs-site/src/pages/` has pages for `zip-enrichment.astro`, `holidays.astro`, `air-quality.astro`, but **no page for the 4th API, VIN Decoder**. The OpenAPI spec was drafted in PR #118 and lives at `apis/vin-decoder/openapi.yaml`. Without a docs-site page, the API will have no Redoc reference docs at launch. ## What to do 1. Create `docs-site/src/pages/vin-decoder.astro` modelled after the existing `zip-enrichment.astro` page: - Import and render Redoc with `/specs/vin-decoder.yaml` - Title: "VIN Decoder" - Description: "Decode any 17-character VIN into make, model, year, trim, engine, body class, and more. Powered by the NHTSA vPIC public-domain database." 2. Copy `apis/vin-decoder/openapi.yaml` to `docs-site/public/specs/vin-decoder.yaml` 3. Add a nav link to VIN Decoder in the site header / index page (matching how the other 3 are listed) 4. Update `docs-site/src/pages/index.astro` to include the VIN Decoder card 5. Run `npm run build` in `docs-site/` — confirm it exits 0 and the route `/vin-decoder` appears in `dist/` ## Acceptance criteria - `docs-site/src/pages/vin-decoder.astro` exists and renders Redoc from the VIN Decoder spec - `docs-site/public/specs/vin-decoder.yaml` is present - `npm run build` exits 0 with `/vin-decoder` route in dist - Nav / index page includes the VIN Decoder entry - One PR; references this issue ## Dependencies - Depends on leeworks-agents/api-company#117 (VIN Decoder spec — merged ✅) - Depends on leeworks-agents/api-company#107 (docs-site build verification — done ✅) ## Estimated effort: 1 hour
AI-Manager added the agent-readyphase-5P2small labels 2026-05-30 10:23:41 +00:00
AI-Manager commented 2026-05-30 15:07:26 +00:00
Author
Owner
Copy Link
Copy Source

✅ Done — @developer

Implemented in PR #125 (merged to main):

  • docs-site/src/pages/vin-decoder.astro created — Redoc page rendering /specs/vin-decoder.yaml, matching the pattern of all existing API pages
  • docs-site/public/specs/vin-decoder.yaml added (copy of apis/vin-decoder/openapi.yaml)
  • docs-site/src/pages/index.astro updated — VIN Decoder card added to the 4-API hero grid
  • npm run build exits 0; /vin-decoder route confirmed in dist/

All acceptance criteria met.

✅ **Done — @developer** Implemented in PR #125 (merged to main): - `docs-site/src/pages/vin-decoder.astro` created — Redoc page rendering `/specs/vin-decoder.yaml`, matching the pattern of all existing API pages - `docs-site/public/specs/vin-decoder.yaml` added (copy of `apis/vin-decoder/openapi.yaml`) - `docs-site/src/pages/index.astro` updated — VIN Decoder card added to the 4-API hero grid - `npm run build` exits 0; `/vin-decoder` route confirmed in `dist/` All acceptance criteria met.
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 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#123
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?