alex/headquarter
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(project-map): regenerate .pi-map artifacts across the repo

Browse Source
This commit is contained in:
Developer
2026-06-17 11:31:24 +00:00
parent 0dd5f2317b
commit 93da9b42a2
683 changed files with 5075 additions and 4965 deletions
Download Patch File Download Diff File Expand all files Collapse all files
openspec/changes/archive/2026-05-19-api-documentation/.pi-map.md
+9 -9
View File
@@ -1,18 +1,18 @@
# 2026-05-19-api-documentation
dir: 2026-05-19-api-documentation
# openspec/changes/archive/2026-05-19-api-documentation
dir: openspec/changes/archive/2026-05-19-api-documentation
index: 2026-05-19-api-documentation/.pi-map.index.md
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
## role
Planning and design documents for improving API documentation in a FastAPI-based application.
Archive directory preserving historical API documentation improvement proposals and their implementation tracking for a FastAPI project.
## files
- design.md | Design document outlining API documentation structure, health endpoints, and OpenAPI enhancements for a FastAPI-based application | dep: FastAPI, Pydantic v2, psutil, SQLAlchemy, PostgreSQL, Docker
- proposal.md | Proposes a comprehensive API documentation improvement plan for a FastAPI-based project | dep: FastAPI, OpenAPI/Swagger, ReDoc, Pydantic, apps/api/README.md, docs/architecture/decisions/
- tasks.md | Project task tracking document for API documentation improvements across health endpoints, endpoint documentation, model documentation, README creation, architecture decisions, and quality gates
- design.md | Design document outlining API documentation structure, health endpoints, and architecture decisions for a FastAPI-based application | dep: FastAPI, Pydantic, psutil, SQLAlchemy, PostgreSQL, Docker, OpenAPI/Swagger
- proposal.md | Proposes a plan to add comprehensive API documentation, health monitoring, and developer onboarding materials to a FastAPI-based project. | dep: FastAPI, OpenAPI/Swagger, Pydantic, ADR
- tasks.md | Tracks completed API documentation tasks across health endpoints, endpoint documentation, model documentation, README creation, architecture decisions, and quality verification for a FastAPI-based project.
## arch
Documentation-driven development with structured markdown specifications covering OpenAPI enhancements, health endpoint standards, and phased task tracking for documentation quality gates.
Document-driven change management using sequential design-proposal-tasks workflow with markdown-based specification and progress tracking.
## tags
documentation, api, fastapi, design, document, health, endpoints, openapi
documentation, fastapi, design, api, health, tasks, endpoints, architecture
## symbols
-
## workflows