Skip to content

GitHub Action

Integrate Readability into your CI/CD pipeline to automatically check documentation quality on every pull request.

Basic Usage

name: Documentation Quality

on:
  pull_request:
    paths:
      - 'docs/**'

jobs:
  readability:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: adaptive-enforcement-lab/readability@v1
        with:
          path: docs/
          check: true

Features

  • Automatic Go installation and build
  • Multiple output formats
  • Threshold enforcement
  • Configuration file support

Next Steps