On every PR (in any key projects of the org), if a documentation page content is changed, trigger a technical accuracy check against relevant source code.
- When a PR is raised, trigger a check that decides whether the PR changes contain docs change
- If docs change, trigger
auditAgainstSourceCode to find technical mistakes
- Post the analysis as PR comment
Signals to detect whether the changes are related to docs?
- Conventional commit message starts with
docs: or readme:
.md files are generally docs files.
On every PR (in any key projects of the org), if a documentation page content is changed, trigger a technical accuracy check against relevant source code.
auditAgainstSourceCodeto find technical mistakesSignals to detect whether the changes are related to docs?
docs:orreadme:.mdfiles are generally docs files.