Docs/changelog and static api reference

[Vraj1234]

📄 Description

Adds two handoff-readiness improvements identified in the project health report:

1. CHANGELOG.md — documents notable changes grouped by Added / Changed / Fixed, following Keep a Changelog format. Symlinked into docs/ so it appears in the MkDocs site.

2. Static API reference page — generates a committed docs/api/openapi.json from the FastAPI app and renders it via RapiDoc in MkDocs (docs/api/webservice.md). Incoming maintainers can browse all endpoints, parameters, and response schemas without running the server. A generate-openapi pixi task regenerates the spec when the API changes.

✅ Checklist

• I ran pre-commit run --all-files and all checks pass
• Tests added/updated where needed
• Docs added/updated if applicable
• I have linked the issue this PR closes (if any)

🔗 Related Issues

No direct issue — addresses items from the handoff readiness report (supporting_files/handoff_status_2026-03-20.md):

• [CRITICAL] Add CHANGELOG.md
• [RECOMMENDED] Add a static API reference page

💡 Type of change

Type	Checked?
🐞 Bug fix	[ ]
✨ New feature	[ ]
📝 Documentation	[x]
♻️ Refactor	[ ]
🛠️ Build/CI	[ ]
Other (explain)	[ ]

🧪 How to test

1. CHANGELOG — run pixi run docs-serve and navigate to Changelog in the sidebar; confirm entries are visible.
2. Static API reference — navigate to API Reference → Webservice API; confirm RapiDoc renders all endpoint groups (ROOT, HEALTH, AUTH, USDA, ANALYSIS, AVAILABILITY) with parameters and response schemas.
3. Regenerate spec — run pixi run -e webservice generate-openapi and confirm docs/api/openapi.json is updated.

📝 Notes to reviewers

• The openapi.json is committed intentionally so the docs site builds without needing the webservice running. It should be regenerated whenever the API changes.
• RapiDoc is loaded from CDN (unpkg.com) via a MkDocs template override (docs/overrides/main.html) scoped only to the webservice API page.
• The TRY buttons in RapiDoc require a running server at http://127.0.0.1:8000 — this is expected behavior for a static reference.

[read-the-docs-community]

Documentation build overview

📚 ca-biositing | 🛠️ Build #32246058 | 📁 Comparing d6fe1f9 against latest (d961724)

  🔍 Preview build  

Show files changed (32 files in total): 📝 29 modified | ➕ 3 added | ➖ 0 deleted

File	Status
404.html	📝 modified
index.html	📝 modified
CHANGELOG/index.html	➕ added
CODE_OF_CONDUCT/index.html	📝 modified
CONTRIBUTING/index.html	📝 modified
api/index.html	📝 modified
architecture/index.html	📝 modified
ca_biositing_local_setup/index.html	📝 modified
datamodels/index.html	📝 modified
deployment/index.html	📝 modified
notebook_setup/index.html	📝 modified
overrides/main.html	➕ added
pipeline/index.html	📝 modified
resources/index.html	📝 modified
webservice/index.html	📝 modified
api/datamodels/index.html	📝 modified
api/pipeline/index.html	📝 modified
api/webservice/index.html	➕ added
datamodels/ALEMBIC_VIEW_WORKFLOW/index.html	📝 modified
datamodels/CONTRIBUTING/index.html	📝 modified
datamodels/SCHEMA_DRIFT/index.html	📝 modified
datamodels/SQL_FIRST_WORKFLOW/index.html	📝 modified
pipeline/ALEMBIC_WORKFLOW/index.html	📝 modified
pipeline/CONTRIBUTING/index.html	📝 modified
pipeline/DOCKER_WORKFLOW/index.html	📝 modified
pipeline/ETL_WORKFLOW/index.html	📝 modified
pipeline/GCP_SETUP/index.html	📝 modified
pipeline/PREFECT_WORKFLOW/index.html	📝 modified
webservice/CONTRIBUTING/index.html	📝 modified
pipeline/USDA/ANALYTICS_HANDOFF/index.html	📝 modified
pipeline/USDA/USDA_ETL_GUIDE/index.html	📝 modified
pipeline/USDA/USDA_ETL_HANDOFF/index.html	📝 modified