adaptive-enforcement-lab/Documentation Readability Analyzer
Check docs readability (Flesch-Kincaid, ARI, Fog). Enforce quality thresholds in CI.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Apr 24, 2026
- License
- MIT
Pinned Snippet
uses: adaptive-enforcement-lab/readability@206893a5d5ad3a0039c7e16bc97937c4257741e4 # v3.1.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Path to analyze (file or directory) | no | docs/ |
| format | Output format (table, markdown, json, summary, report) | no | markdown |
| config | Path to config file | no | "" |
| check | Enable check mode (fail on threshold violations) | no | false |
| max-grade | Maximum Flesch-Kincaid grade level | no | "" |
| max-ari | Maximum ARI score | no | "" |
| max-lines | Maximum lines per file | no | "" |
| summary | Write formatted report to job summary (default: true) | no | true |
| summary-title | Title for the job summary section | no | Documentation Readability Report |
| version | Version of readability to use (default: latest) | no | latest |
Outputs
| name | description |
|---|---|
| report | Analysis report in JSON format |
| passed | Whether all thresholds were met (true/false) |
| files-analyzed | Number of files analyzed |