docs(configuration): fix reference accuracy and style drift#12205
Merged
Conversation
Member
Author
|
This pull request is part of a Mergify stack:
|
This was referenced Jul 26, 2026
Contributor
Merge Protections🟢 All 6 merge protections satisfied — ready to merge. Show 6 satisfied protections🟢 🤖 Continuous Integration
🟢 👀 Review Requirements
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 🔎 Reviews
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
Pull request overview
This PR performs an accuracy + style cleanup pass across several configuration reference pages, aligning content with the config schema/engine behavior and reducing prose/style drift.
Changes:
- Updates configuration docs for correctness (e.g., supported
check-*qualifiers, valid duration units, merged keys inextendscautions). - Fixes broken/incorrect links and closes an unclosed MDX caution directive.
- Applies a conservative style/grammar pass and corrects a typo in an example check name.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/content/docs/configuration/sharing.mdx | Refines intro prose, fixes an example typo, and corrects/finishes the extends merging caution block. |
| src/content/docs/configuration/file-format.mdx | Improves introductory wording, fixes the extends link target, and documents the missing scopes top-level key. |
| src/content/docs/configuration/data-types.mdx | Removes nonexistent duration unit (“week”), makes the Jinja2 deprecation notice dateless, and applies multiple phrasing/grammar fixes. |
| src/content/docs/configuration/conditions.mdx | Fixes a broken anchor link and updates supported qualified @app/check attributes (adds check-cancelled) plus minor wording fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
First docs-health audit pass over the configuration reference pages. Accuracy fixes verified against the config JSON schema and the engine source: - conditions: add `check-cancelled` to the attributes supporting the qualified `@app/check` form (engine CHECK_ATTRIBUTES includes it) - data-types: remove the nonexistent "week" duration unit (engine accepts only days/hours/minutes/seconds) - sharing: the extends-merge caution now lists all dict-merged keys (`merge_queue` and `merge_protections_settings` were missing); close the caution directive that never closed (inline `:::`) - file-format: add the missing `scopes` top-level key; fix the anchor to extending-configuration-files (heading lives on /configuration/sharing) - data-types: make the Jinja2 deprecation notice dateless per the repo rule - sharing: fix `functionnal` typo in an example check name Plus a conservative style pass per the proofread rubrics: banned words, prose em dashes, throat-clearing intros, and ~15 grammar fixes. Part of the first manual docs-health audit (MRGFY-8212). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Change-Id: Ia552416708bfdbb4d6fe882084bc3d234cdddb5a
jd
force-pushed
the
devs/jd/jd/mrgfy-8212-docs-health-non-deterministic-audit-loop-style-accuracy/fix-ref-accuracy-style-drift--a5524167
branch
from
July 26, 2026 08:23
23a05f1 to
3b32271
Compare
Member
Author
Revision history
|
kozlek
approved these changes
Jul 27, 2026
JulianMaurin
approved these changes
Jul 27, 2026
Contributor
Merge Queue Status
This pull request spent 2 minutes 48 seconds in the queue, including 2 minutes 12 seconds running CI. Required conditions to merge
|
53 tasks
mergify
Bot
deleted the
devs/jd/jd/mrgfy-8212-docs-health-non-deterministic-audit-loop-style-accuracy/fix-ref-accuracy-style-drift--a5524167
branch
July 27, 2026 07:32
55 tasks
mergify Bot
pushed a commit
that referenced
this pull request
Jul 27, 2026
First docs-health audit pass over the action reference pages. Accuracy fixes verified against the config JSON schema and the engine source: - queue: reference `auto_merge_conditions` instead of the deprecated `auto_merge` - comment: fix the copy-pasted rule name in the conflict example (was "comment when a pull request is merged" on a `conflict` condition) - delete_head_branch and rebase: convert dated deprecation notices to dateless markers per the repo rule (both dates had passed; the delete_head_branch date also disagreed with the engine's actual deadline, flagged separately in the audit report) - post_check: drop the unused Button import; name Merge Protections as the feature in prose Every documented option, default, and enum on all 21 action pages was cross-checked against the schema; the rest were accurate. Plus a conservative style pass per the proofread rubrics: banned words, promotional filler sentences, em dashes, and a dozen grammar fixes across 15 pages. Part of the first manual docs-health audit (MRGFY-8212). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Depends-On: #12205
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
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.
First docs-health audit pass over the configuration reference pages. Accuracy
fixes verified against the config JSON schema and the engine source:
check-cancelledto the attributes supporting thequalified
@app/checkform (engine CHECK_ATTRIBUTES includes it)only days/hours/minutes/seconds)
(
merge_queueandmerge_protections_settingswere missing); close thecaution directive that never closed (inline
:::)scopestop-level key; fix the anchor toextending-configuration-files (heading lives on /configuration/sharing)
functionnaltypo in an example check namePlus a conservative style pass per the proofread rubrics: banned words,
prose em dashes, throat-clearing intros, and ~15 grammar fixes.
Part of the first manual docs-health audit (MRGFY-8212).
Co-Authored-By: Claude Fable 5 noreply@anthropic.com