Skip to content

audit all docs updates against source code #79

@gitcommitshow

Description

@gitcommitshow

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.

  1. When a PR is raised, trigger a check that decides whether the PR changes contain docs change
  2. If docs change, trigger auditAgainstSourceCode to find technical mistakes
  3. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions