Eve library

Documentation Validation Report

Guide

Revision 1

On this page

Generated on 9/25/2025, 7:39:40 PM

Overall Summary#

  • Total Validations: 4648
  • Passed: 4123
  • Failed: 525
  • Score: 0% (Grade: F)
  • Validation Duration: 1s

Quality Gates#

  • Api Documentation: ✅ PASSED
  • Content Quality: ❌ FAILED
  • Accessibility: ✅ PASSED
  • Link Validation: ❌ FAILED
  • Code Examples: ❌ FAILED
  • Consistency: ❌ FAILED

Category Breakdown#

API Documentation#

  • Passed: 309
  • Failed: 4
  • Issues: 4

Content Quality#

  • Passed: 3094
  • Failed: 208
  • Issues: 208

Accessibility#

  • Passed: 371
  • Failed: 0
  • Issues: 0
  • Passed: 162
  • Failed: 87
  • Issues: 87

Code Examples#

  • Passed: 33
  • Failed: 12
  • Issues: 45

Consistency#

  • Passed: 154
  • Failed: 214
  • Issues: 214

Recommendations#

  • HIGH: Fix 2 high-priority API documentation issues
  • MEDIUM: Review and improve content quality standards
  • HIGH: Fix broken links to improve user experience
  • HIGH: Standardize API URLs across all code examples
  • LOW: Set up automated validation in CI/CD pipeline

High Priority Issues#

  • missing_service_endpoints: No documented endpoints found for bff service (N/A)
  • missing_service_endpoints: No documented endpoints found for moderation service (N/A)
  • broken_internal_link: Internal link points to non-existent file: adr-0001-microservices-architecture.md (N/A)
  • broken_internal_link: Internal link points to non-existent file: adr-0002-sse-streaming-chat.md (N/A)
  • broken_internal_link: Internal link points to non-existent file: ./kpi-definitions.md (N/A)
  • broken_internal_link: Internal link points to non-existent file: ./business-dashboard.md (N/A)
  • broken_internal_link: Internal link points to non-existent file: ./metrics-api-reference.md (N/A)
  • inconsistent_base_urls: Found inconsistent base URLs: https://api.lilith.app, http://api.lilith.app, https://staging-api.lilith.app, https://api.lilith.app${endpoint}`, (N/A)

Generated by Documentation Validation Pipeline v1.0.0