Edit changelog publish docs#3358
Conversation
📝 WalkthroughWalkthroughThis PR reorganizes changelog documentation across three files. It adds a new optional 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/contribute/publish-changelogs.md`:
- Line 96: Fix the typo in the sentence "Since this method requires generating
files and adding file inclusions for each release, it's preferrable to [publish
bundles directly](`#changelog-directive`)." by replacing "preferrable" with the
correct spelling "preferable" so the sentence reads "...it's preferable to
[publish bundles directly](`#changelog-directive`)."
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: f0a556a1-d36e-46f4-8c2d-d6d9d9c214a2
📒 Files selected for processing (3)
docs/cli/changelog/cmd-render.mddocs/contribute/create-changelogs.mddocs/contribute/publish-changelogs.md
💤 Files with no reviewable changes (1)
- docs/cli/changelog/cmd-render.md
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/contribute/publish-changelogs.md (1)
47-47:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix custom anchor syntax to match MyST markdown standards.
The file uses
[anchor-name]syntax after headings (e.g., line 47:### Publish bundles directly [changelog-directive]), but this is not standard MyST markdown. According to MyST documentation, custom anchors should use(anchor-name)=on the line before the heading, or{#anchor-name}inline if theattrs_blockextension is enabled. The current syntax will not create valid link targets, causing the document's internal references (e.g.,#changelog-directive) to fail.Replace all instances with standard MyST syntax:
(changelog-directive)= ### Publish bundles directlyOr, if attrs extensions are enabled:
### Publish bundles directly {`#changelog-directive`}🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/contribute/publish-changelogs.md` at line 47, The heading "### Publish bundles directly [changelog-directive]" uses nonstandard anchor syntax; replace each occurrence of "[changelog-directive]" (and other similar bracket anchors) with a valid MyST anchor: either add a preceding line with "(changelog-directive)=" followed by "### Publish bundles directly", or, if the attrs_block extension is enabled, convert the heading to "### Publish bundles directly {`#changelog-directive`}"; update all similar headings so internal links like "`#changelog-directive`" resolve correctly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@docs/contribute/publish-changelogs.md`:
- Line 47: The heading "### Publish bundles directly [changelog-directive]" uses
nonstandard anchor syntax; replace each occurrence of "[changelog-directive]"
(and other similar bracket anchors) with a valid MyST anchor: either add a
preceding line with "(changelog-directive)=" followed by "### Publish bundles
directly", or, if the attrs_block extension is enabled, convert the heading to
"### Publish bundles directly {`#changelog-directive`}"; update all similar
headings so internal links like "`#changelog-directive`" resolve correctly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 7ee84028-789b-4381-b1ce-0dd7a39122fe
📒 Files selected for processing (1)
docs/contribute/publish-changelogs.md
This PR cleans up the Publish changelogs docs