| # Documentation Organization | |
| This project keeps the preserved root docs in place and adds a clearer active documentation layer for the Short Hunter datasource gateway. | |
| ## Active | |
| - `README.md` - public entry page and deployment summary | |
| - `docs/active/PRODUCTION_ENTRYPOINT.md` - current production entrypoint | |
| - `docs/active/SHORT_HUNTER_DATASOURCE_CONTRACT.md` - Short Hunter API contract | |
| ## API | |
| - `docs/api/ENDPOINTS.md` - route summary and response shape notes | |
| ## Deployment | |
| - `docs/deployment/HUGGINGFACE_DEPLOYMENT.md` - Hugging Face Space notes | |
| - `docs/deployment/DOCKER_AND_STARTUP.md` - Docker and startup behavior | |
| ## Security | |
| - `docs/security/SECRET_POLICY.md` - public-only and secret-handling rules | |
| ## Archive | |
| - `docs/archive/README.md` - pointer for older status and migration notes | |
| ## Reports | |
| - `SHORT_HUNTER_GATEWAY_IMPLEMENTATION_REPORT.md` | |
| - `docs/reports/` | |
| - root-level legacy reports that are still useful for context | |
| The root-level legacy documentation was intentionally preserved to avoid breaking historical references. When moving files would risk imports or references, we keep the original file and document the preferred location here. | |