docs: Clarify on-demand trigger model and use sentence case#1113
Open
justinegeffen wants to merge 1 commit intomasterfrom
Open
docs: Clarify on-demand trigger model and use sentence case#1113justinegeffen wants to merge 1 commit intomasterfrom
justinegeffen wants to merge 1 commit intomasterfrom
Conversation
- Fix incorrect "automatic" trigger claims in .claude/README.md - Clarify that editorial reviews are on-demand only (not automatic) - Add explicit callout in CLAUDE.md explaining trigger model - Separate local vs PR workflow steps for clarity - Update headings to sentence case in all documentation - Emphasize manual nature: triggered by /editorial-review command only Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates repository documentation to accurately describe the editorial review system as explicitly triggered (on-demand) rather than automatic, and aligns headings to sentence case for consistency.
Changes:
- Clarifies that
/editorial-reviewruns only when explicitly invoked (local command, PR comment, or manual workflow dispatch) and is not triggered by PR events/commits. - Improves contributor guidance by separating local pre-PR steps from PR-based review steps.
- Normalizes heading capitalization in documentation READMEs.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
CLAUDE.md |
Adds an on-demand-only callout and updates a heading to sentence case. |
.claude/README.md |
Corrects trigger semantics (removes “automatic” PR triggers) and clarifies local vs PR workflows. |
.github/scripts/README.md |
Converts headings to sentence case for consistency. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
justinegeffen
added
1. Dev/PM/SME
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes incorrect documentation claims about "automatic" triggers and clarifies that the editorial review system is on-demand only.
Changes
.claude/README.mdCLAUDE.md.github/scripts/README.mdWhy this matters
Previously, the documentation incorrectly stated that agents "automatically review changes" when PRs are opened. This caused confusion about:
The updated documentation makes it crystal clear:
/editorial-reviewcommand (local or PR comment)Related
Builds on #1110 (anti-hallucination improvements) which was already merged to master.