pdf-quiz-generator/docs/README.md
Daniel 2472435863 docs: how article links, highlights and views are actually written
The syntax was known only to the code that parses it. This is the author's
side of it: `[[264|respiratory failure]]` and why the id form is the one that
cannot rot, `==key points==` and the three rules the parser follows,
`{{phrase|tip}}`, what each of the three views is for, how to link a question
or a whole topic, and what deleting does to a draft versus to something that
has been published.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TqXevQJhxFrM7jJg82cgZN
2026-09-12 19:30:43 +02:00

24 lines
1.6 KiB
Markdown

# PedsHub Documentation
Deep technical documentation for the PedsHub pediatric learning platform.
## Pages
| Document | Description |
|----------|-------------|
| [Architecture](architecture.md) | System overview, database schema, multi-worker setup, vector search, auth, rate limiting, concurrent quiz protection |
| [API Reference](api-reference.md) | Every endpoint: method, path, auth, request/response, notes |
| [Services](services.md) | Backend service layer: AI extraction, embedding, vector search, PDF processing, email, reminders |
| [Frontend](frontend.md) | React app structure, pages, components, state patterns, runtime config |
| [Deployment](deployment.md) | Docker setup, environment variables, HTTPS, rebuilding, monitoring, troubleshooting, scaling |
| [Adaptive sessions](adaptive-sessions.md) | What the Adaptive toggle selects, where the code is, and what it deliberately ignores |
| [Study recommendations](study-recommendations.md) | How focus areas are ranked and what readiness means |
| [Writing articles](writing-articles.md) | Cross-reference links, key-point highlights, teaching tips, the three views, linking questions, and what deleting does |
| [Reranking](reranking.md) | Where the cross-encoder is applied and where it deliberately is not |
| [Retrieval thresholds](retrieval-thresholds.md) | The numbers behind sourced / adjacent / open answers |
## Quick Links
- **Main README**: [../README.md](../README.md)
- **Backend .env template**: [../backend/.env.example](../backend/.env.example)
- **Docker Compose**: [../docker-compose.yml](../docker-compose.yml)