Skip to content

docs: deduplicate on-pull-request-runner README → point to GitBook (DEV-4518)#45

Open
dvaliant wants to merge 1 commit into
dev-4567from
docs/readme-orl-runner-dedup
Open

docs: deduplicate on-pull-request-runner README → point to GitBook (DEV-4518)#45
dvaliant wants to merge 1 commit into
dev-4567from
docs/readme-orl-runner-dedup

Conversation

@dvaliant

@dvaliant dvaliant commented Jun 9, 2026

Copy link
Copy Markdown

Summary

Why

DEV-4518: the public docs page for GitHub Actions was updated to include the ORL Runner documentation. Keeping a full copy in the README would create drift as the action evolves. Single source of truth = GitBook.

What stays in the README

  • One-paragraph description
  • Link to full GitBook docs
  • Minimal audit-mode quick start (enough to unblock a new user)
  • Link to examples/consumer-workflow.yml for remediate mode
  • Maintainers section (internal, not in public docs)

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant