Skip to content

Documentation Index

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

Total: 29 documentation files (as of January 2026)

📚 Core Documentation (Root)

  • ../README.md → Project quickstart, badges, installation
  • 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

📖 Guides (guides/)

User-facing operational guides:

  • 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

📋 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/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

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

  • ../LICENSE → MIT License for code
  • ../LICENSE-DATA → CC BY 4.0 License for data/docs
  • ../CONTRIBUTING.md → Contribution guidelines
  • https://github.com/MissCrispenCakes/DigitalChild/blob/basecamp/SECURITY.md → Security policies and vulnerability reporting
  • https://github.com/MissCrispenCakes/DigitalChild/blob/basecamp/CITATION.cff → Academic citation format
  • https://github.com/MissCrispenCakes/DigitalChild/blob/basecamp/CLAUDE.md → AI assistant context

Notes

  • Documentation reorganized January 2026 for better navigation
  • guides/ = operational how-tos
  • planning/ = future features and feasibility
  • reviews/ = analysis and test summaries
  • standards/ = technical specifications
  • notes/ = internal development notes