docs: Clean up editorial workflow documentation#1141
Closed
justinegeffen wants to merge 2 commits intomasterfrom
Closed
docs: Clean up editorial workflow documentation#1141justinegeffen wants to merge 2 commits intomasterfrom
justinegeffen wants to merge 2 commits intomasterfrom
Conversation
The docs-review.yml workflow is manual-only, triggered by /editorial-review comment or workflow dispatch. Previous docs incorrectly stated it runs automatically on PR creation. Changes: - Clarify workflow is entirely manual (no automatic triggers) - Update trigger documentation with correct methods - Reorganize "How it works" section for clarity - Add clear warning about manual-only operation - Add agent status table showing which agents are active/disabled This aligns documentation with actual workflow behavior established in justine-editorialv3 cleanup.
Add deployment sections to all three skills to clarify: - Where each skill is used (local vs CI/CD) - Which workflows invoke them - How they're triggered - Their specific purpose/scope Skills updated: - editorial-review: Used in docs-review.yml workflow - openapi-overlay-generator: Used in generate-openapi-overlays.yml - platform-changelog-formatter: Local-only, not in CI/CD This helps developers understand which skills are automated vs manual-only.
✅ Deploy Preview for seqera-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
|
Consolidated into #1140 (docs/clarify-on-demand-triggers) to avoid duplication. |
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
Documentation cleanup to align with actual editorial workflow behavior and clarify skill deployment context.
Changes
1. Fixed trigger documentation (
.claude/README.md)Problem: Docs claimed workflow runs automatically on PR creation, but it's actually manual-only.
Changes:
/editorial-reviewcommand or manual dispatch2. Added agent status table (
.claude/README.md)Problem: Unclear which agents are active vs disabled.
Changes:
3. Added deployment context to skills
Problem: Unclear which skills are used in CI/CD vs local-only.
Changes:
editorial-review: Documented CI/CD usage in docs-review.ymlopenapi-overlay-generator: Documented CI/CD usage in generate-openapi-overlays.ymlplatform-changelog-formatter: Clarified as local-only (not in CI/CD)Motivation
As part of reviewing the editorial workflow evolution, found critical documentation bugs that could confuse contributors about when workflows trigger and which tools are automated.
Testing
Related
Part of editorial system cleanup and consolidation.
🤖 Generated with Claude Code