Skip to content

docs(workflow): align action descriptions and correct the edit action#11908

Merged
mergify[bot] merged 4 commits into
mainfrom
devs/JulianMaurin/docs-workflow-overview/align-action-descriptions-correct-edit-action--935508fd
Jun 24, 2026
Merged

docs(workflow): align action descriptions and correct the edit action#11908
mergify[bot] merged 4 commits into
mainfrom
devs/JulianMaurin/docs-workflow-overview/align-action-descriptions-correct-edit-action--935508fd

Conversation

@JulianMaurin

Copy link
Copy Markdown
Contributor

Make each action read identically across the actions index and its page frontmatter (copy, comment, label, queue) to match the overview cards. Correct the edit action: its config schema only exposes the draft state, so its card, description, and intro no longer claim it edits the body or title.

Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com

Depends-On: #11907

JulianMaurin and others added 4 commits June 23, 2026 16:51
Replace the stub overview with a hub page matching the other products: a benefit-led intro, an annotated pull_request_rules example, the edge-triggering note, and DocsetGrid cards for the building blocks and the most-used actions. Render the title in the section accent via hubAccent.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: I21f19283a7dc5eccb499e1d264b151d2366812c5
Replace the placeholder stub with a field-by-field reference: the pull_request_rules fields table, how conditions and actions compose, rule evaluation, disabling a rule, and local validation. The conceptual intro is left to the overview to avoid duplication.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: I4fa35918e0f13360b29905f901ccb0a6ada88ecf
Rename the overview child from "Workflow Automation" to "Overview" to match the other products, and fix two stale action icons: Comment (list -> message-square) and Edit (type -> git-pull-request-draft, since the action only toggles draft state).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: I34dd8408ab47eedd35fa2915f77ea82259e56f70
Make each action read identically across the actions index and its page frontmatter (copy, comment, label, queue) to match the overview cards. Correct the edit action: its config schema only exposes the draft state, so its card, description, and intro no longer claim it edits the body or title.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Change-Id: I935508fd79dc15c9e17350c8583bfbe534f18638
@JulianMaurin

Copy link
Copy Markdown
Contributor Author

This pull request is part of a Mergify stack:

# Pull Request Link
1 docs(workflow): rebuild the overview into a product landing hub #11905
2 docs(workflow): rewrite the Rule Syntax page as a real reference #11906
3 docs(workflow): refresh the section navigation entries #11907
4 docs(workflow): align action descriptions and correct the edit action #11908 👈
5 docs(workflow): add examples to actions that lacked them #11909
6 docs(workflow): normalize action page formatting and fix typos #11910
7 docs(config): fix Workflow Automation naming and the priority_rules key #11911

@mergify

mergify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Merge Protections

🟢 All 7 merge protections satisfied — ready to merge.

Show 7 satisfied protections

🟢 ⛓️ Depends-On Requirements

Requirement based on the presence of Depends-On in the body of the pull request

🟢 🤖 Continuous Integration

  • all of:
    • check-success = build
    • check-success = lint
    • check-success = test
    • any of:
      • check-success = test-broken-links
      • label = ignore-broken-links
    • any of:
      • check-success=Cloudflare Pages
      • -head-repo-full-name~=^Mergifyio/

🟢 👀 Review Requirements

  • any of:
    • #approved-reviews-by >= 2
    • author = dependabot[bot]
    • author = mergify-ci-bot

🟢 Enforce conventional commit

Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/

  • title ~= ^(fix|feat|docs|style|refactor|perf|test|build|ci|chore|revert|ui)(?:\(.+\))?:

🟢 🔎 Reviews

  • #changes-requested-reviews-by = 0
  • #review-requested = 0
  • #review-threads-unresolved = 0

🟢 📕 PR description

  • body ~= (?ms:.{48,})

🟢 🚦 Auto-queue

When all merge protections are satisfied, this pull request will be queued automatically.

@JulianMaurin JulianMaurin marked this pull request as ready for review June 23, 2026 14:55
@mergify mergify Bot requested a review from a team June 23, 2026 14:56
kozlek
kozlek previously approved these changes Jun 24, 2026
@mergify mergify Bot requested a review from a team June 24, 2026 07:36
Base automatically changed from devs/JulianMaurin/docs-workflow-overview/refresh-section-navigation-entries--34dd8408 to main June 24, 2026 09:56
@mergify mergify Bot dismissed kozlek’s stale review June 24, 2026 09:56

The base branch was changed.

@mergify mergify Bot requested a review from a team June 24, 2026 12:53
@mergify

mergify Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Queued — the merge queue status continues in this comment ↓.

@mergify

mergify Bot commented Jun 24, 2026

Copy link
Copy Markdown
Contributor

Merge Queue Status

This pull request spent 2 minutes 50 seconds in the queue, including 1 minute 58 seconds running CI.

Required conditions to merge

@mergify mergify Bot added the queued label Jun 24, 2026
@mergify mergify Bot merged commit 21f1c54 into main Jun 24, 2026
8 checks passed
@mergify mergify Bot deleted the devs/JulianMaurin/docs-workflow-overview/align-action-descriptions-correct-edit-action--935508fd branch June 24, 2026 13:19
@mergify mergify Bot removed the queued label Jun 24, 2026
mergify Bot pushed a commit that referenced this pull request Jun 24, 2026
Add an Examples section to dismiss_reviews, rebase, and request_reviews, each with a schema-checked pull_request_rules snippet, matching the pattern of the other action pages. Also normalize rebase's ActionOptionsTable quoting and fix a note typo.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

Depends-On: #11908
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

3 participants