atakanonat/DocRig — Documentation Auditor
Scan documentation for broken links, orphan pages, and dead-end pages using DocRig.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Path to the documentation directory to scan (relative to repo root). | no | docs |
| fail-on-broken | Fail the action if broken link count exceeds this value. Set to -1 to never fail on broken links. | no | 0 |
| fail-on-orphans | Fail the action if orphan page count exceeds this value. Omit to disable. | no | "" |
| format | Output format: text, json, or html. | no | text |
| output | Write the report to this file (relative to repo root). Leave empty to print to stdout only. | no | "" |
| baseline | Path to a baseline JSON produced by save-baseline. When provided, runs diff instead of scan. | no | "" |
| fail-on-regression | When diffing against a baseline, fail if any new issues are introduced. | no | true |
| rust-version | Rust toolchain version to install. | no | stable |
Outputs
| name | description |
|---|---|
| broken-links | Number of broken links found. |
| orphan-pages | Number of orphan pages found. |
| dead-end-pages | Number of dead-end pages found. |
| total-files | Total number of documentation files scanned. |