Generated: 10/14/2025, 9:08:03 AM
Summary#
- Total Validations: 5
- Passed: 5 ✅
- Failed: 0 ❌
- Total Errors: 0
- Total Warnings: 148
- Total Info: 11
🎉 All validations passed! Documentation quality is excellent.
Detailed Results#
✅ API Documentation#
Information (2)#
- Found 8 service API documentation files
- OpenAPI specification found - API docs should be in sync
✅ Architecture Documentation#
Information (3)#
- Found architecture file: services.md
- Found architecture file: system-overview.md
- Found 47 services in codebase
✅ User Guides#
Warnings (1)#
- chat-guide.md seems too short (453 words)
Information (5)#
- Found user guide: chat-guide.md
- Found user guide: meditation-guide.md
- meditation-guide.md has substantial content (612 words)
- Found user guide: content-guide.md
- content-guide.md has substantial content (821 words)
✅ Documentation Links#
Information (1)#
- Found 35 markdown files to check
✅ Documentation Consistency#
Warnings (147)#
- Multiple H1 headings in api/README.md (line 57)
- Multiple H1 headings in api/README.md (line 60)
- Multiple H1 headings in business-metrics/analytics-integration-guide.md (line 249)
- Multiple H1 headings in business-metrics/analytics-integration-guide.md (line 252)
- Multiple H1 headings in business-metrics/analytics-integration-guide.md (line 255)
- Multiple H1 headings in business-metrics/analytics-integration-guide.md (line 262)
- Multiple H1 headings in business-metrics/analytics-integration-guide.md (line 265)
- Multiple H1 headings in business-metrics/analytics-integration-guide.md (line 268)
- Multiple H1 headings in business-metrics/kpi-catalog.md (line 111)
- Multiple H1 headings in business-metrics/kpi-catalog.md (line 114)
- Multiple H1 headings in security/incident-response-playbooks.md (line 146)
- Multiple H1 headings in security/incident-response-runbooks.md (line 103)
- Multiple H1 headings in security/incident-response-runbooks.md (line 106)
- Multiple H1 headings in security/incident-response-runbooks.md (line 109)
- Multiple H1 headings in security/incident-response-runbooks.md (line 115)
- Multiple H1 headings in security/incident-response-runbooks.md (line 118)
- Multiple H1 headings in security/incident-response-runbooks.md (line 121)
- Multiple H1 headings in security/security-monitoring.md (line 160)
- Multiple H1 headings in security/threat-detection-guide.md (line 117)
- Multiple H1 headings in security/threat-detection-guide.md (line 120)
- Multiple H1 headings in security/threat-detection-guide.md (line 123)
- Multiple H1 headings in security/threat-detection-guide.md (line 130)
- Multiple H1 headings in security/threat-detection-guide.md (line 141)
- Multiple H1 headings in user-guides/guides/getting-started.md (line 25)
- Table 1 has inconsistent column count in business-metrics/README.md
- Table 2 has inconsistent column count in business-metrics/README.md
- Table 4 has inconsistent column count in business-metrics/README.md
- Table 5 has inconsistent column count in business-metrics/README.md
- Table 6 has inconsistent column count in business-metrics/README.md
- Table 1 has inconsistent column count in business-metrics/analytics-integration-guide.md
- Table 1 has inconsistent column count in business-metrics/analytics-integration-guide.md
- Table 1 has inconsistent column count in business-metrics/kpi-definitions.md
- Table 2 has inconsistent column count in business-metrics/kpi-definitions.md
- Table 3 has inconsistent column count in business-metrics/kpi-definitions.md
- Table 4 has inconsistent column count in business-metrics/kpi-definitions.md
- Table 5 has inconsistent column count in business-metrics/kpi-definitions.md
- Table 6 has inconsistent column count in business-metrics/kpi-definitions.md
- Table 1 has inconsistent column count in business-metrics/kpi-monitoring-playbooks.md
- Table 1 has inconsistent column count in business-metrics/kpi-monitoring-playbooks.md
- Table 3 has inconsistent column count in business-metrics/kpi-monitoring-playbooks.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 3 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 5 has inconsistent column count in business-metrics/metrics-api-reference.md
- Table 1 has inconsistent column count in security/README.md
- Table 2 has inconsistent column count in security/README.md
- Table 4 has inconsistent column count in security/README.md
- Table 5 has inconsistent column count in security/README.md
- Table 1 has inconsistent column count in security/security-api-reference.md
- Table 2 has inconsistent column count in security/security-api-reference.md
- Table 4 has inconsistent column count in security/security-api-reference.md
- Table 5 has inconsistent column count in security/security-api-reference.md
- Table 1 has inconsistent column count in security/threat-detection-guide.md
- Table 2 has inconsistent column count in security/threat-detection-guide.md
- Table 4 has inconsistent column count in security/threat-detection-guide.md
- Table 5 has inconsistent column count in security/threat-detection-guide.md
- Table 1 has inconsistent column count in user-guides/guides/troubleshooting.md
- Table 2 has inconsistent column count in user-guides/guides/troubleshooting.md
- Table 4 has inconsistent column count in user-guides/guides/troubleshooting.md
- Table 5 has inconsistent column count in user-guides/guides/troubleshooting.md
Recommendations#
Priority 2: Address Warnings#
Review warnings to improve documentation quality and user experience.
Priority 3: Continuous Improvement#
- Set up automated validation in CI/CD pipeline
- Schedule regular documentation reviews
- Keep documentation in sync with code changes
- Gather user feedback on documentation clarity
This report was generated automatically by the documentation validation pipeline.