Documentation¶
The documentation follows Diátaxis: learn through tutorials, complete tasks with how-to guides, look up reference material or explore the reasoning in Explanation.
New here? Find your starting point · Explore data & tools · Research projects
Tutorials¶
Learn by doing, with a guided sequence and expected results.
- Explore your first country assessment — no installation or account needed.
- Install and run your first pipeline — work locally, inspect outputs, and learn how the pipeline fits together.
How-to guides¶
Complete a particular task. Use these when you know the outcome you want.
- Download the published data or generate exports
- Install the pipeline
- Make your first self-hosted API request
- Run the pipeline
- Update a scorecard
- Use the validators
- Deploy your own API
- Troubleshoot first-run errors
Reference¶
Look up precise information: definitions, interfaces, and formats.
- API endpoint reference · Endpoint quick reference
- Glossary
- Metadata schema · Tags configuration
- File naming · Directory structure
- Pipeline logging
- Complete documentation index
Explanation¶
Understand the reasoning, assumptions, and limits behind the work.
- Scorecard design and methodology
- Research context
- Architecture · Pipeline flow
- Data governance
- Site practices and data handling
Research record and citations¶
The technical overview describes the research pipeline and project structure, with a software citation. See the API implementation history and software roadmap for technical development. Programme origins and planned investigations are in Research history and Research directions.