conalh/Docs Debt Radar

Scan repository documentation for evidence-backed docs debt findings.

Trust Signals

name	description	required	default
path	Repository path to scan.	no	.
fail-on	Severity threshold that should fail the workflow. Use none for report-only mode.	no	none
report-format	Report artifact format. Supported values are markdown and json.	no	markdown
docs	Optional newline- or comma-separated Markdown docs paths to scan.	no	""
changed-only	Scan only changed Markdown docs reported by git status.	no	false
changed-since	Scan only Markdown docs changed since a git ref.	no	""
check-external-links	Check external Markdown links with network requests.	no	false
pr-comment	Post a Docs Debt Radar summary comment on pull requests.	no	false
github-token	GitHub token used when pr-comment is enabled.	no	""
report-path	Path where the report artifact content should be written.	no	docs-debt-report.md
artifact-name	Name for the uploaded report artifact.	no	docs-debt-report

name	description
exit-code	Exit code returned by the docs debt scan.
report-path	Path to the generated report.
total-findings	Total visible findings in the report.
suppressed-findings	Total suppressed findings in the report.