Skip to content

Documentation Index

This index lists all documentation files in docs/ organized by category.

Total: 47 documentation files (as of January 2026)

📚 Core Documentation (Root)

  • index.md → GRIMdata homepage (landing page)
  • README.md → Documentation overview and navigation
  • DOCS_INDEX.md → This index
  • ARCHITECTURE.md → System architecture and components
  • FAQ.md → Frequently asked questions
  • GLOSSARY.md → Definitions of key terms
  • DATA_GOVERNANCE.md → Privacy, ethics, data handling policies
  • ROADMAP.md → Project roadmap and phases
  • CONTRIBUTING.md → Contribution guidelines (also in root)

🚀 Getting Started (getting-started/)

New user guides:

  • getting-started/installation.md → Installation and setup instructions
  • getting-started/quickstart.md → Quick start guide for first-time users

📖 User Guides (guides/)

Operational guides for users:

  • guides/RUNBOOK.md → Comprehensive commands for all operations
  • guides/FIRST_RUN_ERRORS.md → Troubleshooting first-run issues
  • guides/SCORECARD_WORKFLOW.md → Complete scorecard system guide
  • guides/VALIDATORS_USAGE.md → Using the validation framework

🌐 API Documentation (../api/)

REST API backend documentation (Phase 4 - Complete):

  • api/README.md → Complete API documentation, endpoints, usage (14 endpoints)
  • ../api/QUICK_START.md → Fast reference guide for API usage
  • API_WEEK1_SUMMARY.md → Week 1 implementation summary (foundation)
  • API_WEEK2_SUMMARY.md → Week 2 implementation summary (core endpoints)
  • API_DEPENDENCY_UPDATE.md → Dependency updates and security patches (Jan 2026)
  • ../test_api.py → API health check script
  • ../test_dependency_updates.sh → Dependency update verification script
  • guides/PRODUCTION_DEPLOYMENT.md → Complete production deployment guide (Docker, Redis, Nginx)

🌈 Projects (projects/)

Project-specific documentation:

  • projects/littlerainbowrights/index.md → LittleRainbowRights project overview
  • projects/sgbv/index.md → SGBV-UPR project overview

📊 Scorecard (scorecard/)

Scorecard visualization and data:

  • scorecard/index.md → Scorecard visualization and indicators
  • scorecard/explorer.md → Data explorer interface

📋 Planning (planning/)

Planning and feasibility documents:

  • planning/SOURCE_FEASIBILITY_CHECKLIST.md → Evaluating new data sources
  • planning/TAGS_VISUALIZATION_PLAN.md → Future visualization features

🔍 Reviews (reviews/)

Test runs and review summaries:

  • reviews/SCORECARD_REVIEW_SUMMARY.md → Scorecard analysis and review
  • reviews/PROCESSOR_TEST_RUN.md → Processor testing commands and results

📏 Standards (standards/)

Technical standards and schemas:

  • standards/METADATA_SCHEMA.md → Document metadata structure
  • standards/FILE_NAMING_STANDARDS.md → File naming conventions
  • standards/DOC_TYPE_STANDARDS.md → Document type categorization
  • standards/ISO_MAPPING.md → Country/region normalization
  • standards/TAGS_CONFIG_FORMAT.md → Tag configuration structure
  • standards/RECOMMENDATIONS_CONFIG_FORMAT.md → Recommendations config format
  • standards/COMPARISON_CONFIG_FORMAT.md → Comparison config format
  • standards/FILTERS_CONFIG_FORMAT.md → Filters configuration format
  • standards/SCRAPER_STRUCTURE.md → Scraper implementation guide

📝 Notes (notes/)

Internal development notes:

  • notes/DIRECTORY_STRUCTURE.md → Codebase folder organization
  • notes/PIPELINE_FLOW.md → End-to-end pipeline execution
  • notes/PIPELINE_LOGGING.md → Logging system details
  • notes/TAGS_MAIN_NOTES.md → Tag version management
  • notes/TAGS_EXPORT_NOTES.md → Tag summary CSV interpretation
  • notes/COMPARISON_EXPORT_NOTES.md → Comparison export format
  • notes/NEXT_STEPS_PLAN.md → Future development priorities

These files live in the project root, not docs/:

  • ../LICENSE → MIT License for code
  • ../LICENSE-DATA → CC BY 4.0 License for data/docs
  • ../SECURITY.md → Security policies and vulnerability reporting
  • ../CITATION.cff → Academic citation format
  • ../DEPLOYMENT_GUIDE.md → Deployment instructions

🛠 Maintenance (maintenance/)

Scorecard maintenance documentation:

  • maintenance/SCORECARD_MAINTENANCE_REPORT.md → Analysis of scorecard data staleness
  • maintenance/SCORECARD_UPDATE_GUIDE.md → Step-by-step update procedures
  • maintenance/SCORECARD_PHASE1_UPDATES.md → Phase 1 critical updates log

Notes

  • Documentation reorganized January 2026 for better navigation
  • Phase 4 API documentation complete January 2026 (14 endpoints operational, production-ready)
  • getting-started/ = new user onboarding
  • guides/ = operational how-tos
  • projects/ = project-specific overviews
  • scorecard/ = data visualization and exploration
  • planning/ = future features and feasibility
  • reviews/ = analysis and test summaries
  • standards/ = technical specifications
  • notes/ = internal development notes
  • maintenance/ = scorecard update tracking
  • api/ = REST API backend (Flask with authentication, rate limiting, Docker deployment)