daniel/email-classifier
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add MkDocs documentation #5

Merged
daniel merged 4 commits from docs/mkdocs into main 2026-04-09 20:57:50 +00:00
Conversation 0 Commits 4 Files Changed 9 +698
lennie-s commented 2026-04-09 20:25:37 +00:00
Collaborator
Copy Link

Summary

Adds comprehensive MkDocs documentation covering:

  • Overview — Purpose, features, and project structure
  • Setup — Local installation and Docker
  • API Reference — Full request/response shapes for POST /classify
  • Configuration — All environment variables with provider-specific examples
  • Testing — curl examples and Swagger UI usage
  • Deployment — Docker, CI/CD, and production checklist
  • Known Quirks — MiniMax base URL gotcha, SQLite path, dedupe limitations, and more

Files

  • mkdocs.yml — Material for MkDocs configuration
  • docs/index.md — Overview
  • docs/setup.md — Installation and quick start
  • docs/api.md — API reference
  • docs/configuration.md — Environment variables
  • docs/testing.md — Local testing guide
  • docs/deployment.md — Docker and CI/CD deployment
  • docs/quirks.md — Known quirks and limitations
## Summary Adds comprehensive MkDocs documentation covering: - **Overview** — Purpose, features, and project structure - **Setup** — Local installation and Docker - **API Reference** — Full request/response shapes for POST /classify - **Configuration** — All environment variables with provider-specific examples - **Testing** — curl examples and Swagger UI usage - **Deployment** — Docker, CI/CD, and production checklist - **Known Quirks** — MiniMax base URL gotcha, SQLite path, dedupe limitations, and more ## Files - `mkdocs.yml` — Material for MkDocs configuration - `docs/index.md` — Overview - `docs/setup.md` — Installation and quick start - `docs/api.md` — API reference - `docs/configuration.md` — Environment variables - `docs/testing.md` — Local testing guide - `docs/deployment.md` — Docker and CI/CD deployment - `docs/quirks.md` — Known quirks and limitations
lennie-s added 1 commit 2026-04-09 20:25:38 +00:00
Add MkDocs documentation 760b56bfd6 
Covers: overview, setup, API reference, configuration,
testing, deployment, and known quirks.
lennie-s added 1 commit 2026-04-09 20:48:11 +00:00
Fix mkdocs.yml: remove invalid pymdownx.snippets autoindent option bcf660f222
steve-w added 1 commit 2026-04-09 20:52:20 +00:00
Fix MkDocs docs_dir and ignore docs virtualenv 39c0d787fc
lennie-s added 1 commit 2026-04-09 20:55:59 +00:00
Fix pipe escaping in API docs tables 8d1109c309
daniel merged commit 9f259a299f into main 2026-04-09 20:57:50 +00:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
lennie-s marcus-a steve-w daniel
No Assignees
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: daniel/email-classifier#5
Delete Branch "docs/mkdocs"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?