momentry_core/docs_v1.0/API_WORKSPACE/README.md

API Workspace

Purpose

This directory is the single source of truth for all API documentation modules. Generated outputs go to ../GUIDES/ as assembled deliverable documents.

Workflow

# 1. Edit a module
vim modules/09_tmdb.md

# 2. Preview the generated output
make _build/API_ENDPOINTS.md

# 3. Check diff against current GUIDES/ content
make check

# 4. Deploy to GUIDES/
make deploy

# 5. Regenerate all
make all

Directory Structure

API_WORKSPACE/
├── modules/         ← 11 module files (01_auth ... 11_error_codes)
├── configs/         ← 7 assembly recipies (.toml)
├── narratives/      ← narrative intros for specific output files
├── _build/          ← generated output (gitignored)
├── Makefile         ← build targets
├── assemble_docs.sh ← assembly engine
└── README.md

Available make Targets

Target	Output
make reference	_build/API_REFERENCE.md
make endpoints	_build/API_ENDPOINTS.md
make quickref	_build/API_QUICK_REFERENCE.md
make errors	_build/API_ERROR_CODES.md
make index	_build/API_INDEX.md
make marcom	_build/API_TRAINING_MARCOM.md
make tmdb	_build/TMDb_User_Guide.md
make all	All of the above
make deploy	Copy _build/* → ../GUIDES/
make check	diff against existing ../GUIDES/ files

Adding a New Endpoint

1. Add the endpoint to the appropriate module (e.g., modules/XX_files.md)
2. Follow the template in modules/_template.md
3. make all && make check
4. make deploy