chore: track all project map and index files
Add generated .pi-map.md and .pi-map.index.md files across the repository so the project navigation maps are shared and versioned. These artifacts are maintained by project_map_init/patch/validate and must be kept in sync with source edits. Note: .cache/ remains ignored (added in previous commit).
This commit is contained in:
@@ -0,0 +1,19 @@
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/.openspec (index)
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
|
||||
## role
|
||||
Defines a schema-driven API documentation specification configuration for the OpenSpec changes archive.
|
||||
## parent
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- config.yaml
|
||||
## links
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,19 @@
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Defines a schema-driven API documentation specification configuration for the OpenSpec changes archive.
|
||||
## files
|
||||
- config.yaml | Defines a configuration file specifying a schema-driven API documentation specification
|
||||
## arch
|
||||
YAML-based declarative configuration pattern specifying schema metadata for API documentation generation.
|
||||
## tags
|
||||
config, defines, configuration, specifying, schema, driven, api, documentation
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,26 @@
|
||||
# openspec/changes/archive/2026-05-19-api-documentation (index)
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation
|
||||
|
||||
## role
|
||||
Planning and design documents for a comprehensive API documentation improvement initiative targeting a FastAPI-based application.
|
||||
## parent
|
||||
index: openspec/changes/archive/.pi-map.index.md
|
||||
map: openspec/changes/archive/.pi-map.md
|
||||
## children
|
||||
- openspec/changes/archive/2026-05-19-api-documentation/.openspec
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.openspec/.pi-map.md
|
||||
- openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.md
|
||||
## files
|
||||
- design.md
|
||||
- proposal.md
|
||||
- tasks.md
|
||||
## links
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,21 @@
|
||||
# openspec/changes/archive/2026-05-19-api-documentation
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation
|
||||
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Planning and design documents for a comprehensive API documentation improvement initiative targeting a FastAPI-based application.
|
||||
## 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
|
||||
## arch
|
||||
Document-driven planning architecture with three-tier separation: design specifications (design.md), strategic proposals (proposal.md), and task tracking/execution planning (tasks.md), organized by date-based archival structure for change management.
|
||||
## tags
|
||||
documentation, api, fastapi, design, document, health, endpoints, openapi
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,19 @@
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/specs (index)
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
|
||||
## role
|
||||
Defines API documentation standards and health endpoint specifications for a FastAPI-based project.
|
||||
## parent
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/.pi-map.md
|
||||
## children
|
||||
-
|
||||
## files
|
||||
- spec.md
|
||||
## links
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
map: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.md
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
@@ -0,0 +1,19 @@
|
||||
# openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
dir: openspec/changes/archive/2026-05-19-api-documentation/specs
|
||||
|
||||
index: openspec/changes/archive/2026-05-19-api-documentation/specs/.pi-map.index.md
|
||||
|
||||
## role
|
||||
Defines API documentation standards and health endpoint specifications for a FastAPI-based project.
|
||||
## files
|
||||
- spec.md | Defines API documentation requirements, health endpoint specifications, and documentation standards for a FastAPI-based project | dep: FastAPI, OpenAPI, Pydantic, Swagger UI, ReDoc
|
||||
## arch
|
||||
Specification-driven documentation using Markdown-based API contracts with standardized health check patterns.
|
||||
## tags
|
||||
documentation, fastapi, spec, defines, api, requirements, health, endpoint
|
||||
## symbols
|
||||
-
|
||||
## workflows
|
||||
-
|
||||
## dirty
|
||||
-
|
||||
Reference in New Issue
Block a user