Skip to main content

Documentation Automation

Automated checks for documentation quality using Vale and Spectral. Ensures consistent writing style and API standards.

Setup​

  • Vale Linter - Checks style, grammar, and clarity
  • Spectral - Validates API specifications
  • GitHub Actions - Runs checks on every commit
  • Custom config files for rules

View live workflow logs

Standards Enforced​

Writing (Vale)​

  • Consistent tone and style
  • Active voice
  • Proper heading structure
  • Spelling and grammar
  • Clear, concise language

API Specs (Spectral)​

  • OpenAPI best practices
  • Naming conventions
  • Complete parameter and response descriptions
  • Proper HTTP status codes
  • Clean component structure

Key Learnings​

  • Automated linting in CI/CD pipelines
  • Importance of style consistency
  • OpenAPI specification best practices
  • GitHub Actions workflow management

This setup ensures all documentation meets quality standards automatically.