Skip to content

Edit changelog publish docs#3358

Merged
lcawl merged 4 commits into
mainfrom
changelog-publish-docs
May 20, 2026
Merged

Edit changelog publish docs#3358
lcawl merged 4 commits into
mainfrom
changelog-publish-docs

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented May 19, 2026

This PR cleans up the Publish changelogs docs

@lcawl lcawl marked this pull request as ready for review May 19, 2026 23:47
@lcawl lcawl requested review from a team as code owners May 19, 2026 23:47
@lcawl lcawl requested a review from cotti May 19, 2026 23:47
@lcawl lcawl added the documentation Improvements or additions to documentation label May 19, 2026
@lcawl lcawl enabled auto-merge (squash) May 19, 2026 23:48
@lcawl lcawl mentioned this pull request May 19, 2026
5 tasks
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 19, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR reorganizes changelog documentation across three files. It adds a new optional highlight boolean for changelog entries (documented with an example in create-changelogs.md), consolidates output-format publishing workflows into publish-changelogs.md (Asciidoc, Elastic Docs V3 via {changelog} or rendered Markdown, and GFM), and removes the redundant "Output formats" section from the cmd-render command reference.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Edit changelog publish docs' directly refers to the main change: reorganization and cleanup of the publish-changelogs.md documentation file.
Description check ✅ Passed The description states the PR cleans up the Publish changelogs docs, which aligns with the changes to docs/contribute/publish-changelogs.md and related documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch changelog-publish-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 908493a and d4068f8.

📒 Files selected for processing (3)
  • docs/cli/changelog/cmd-render.md
  • docs/contribute/create-changelogs.md
  • docs/contribute/publish-changelogs.md
💤 Files with no reviewable changes (1)
  • docs/cli/changelog/cmd-render.md

Comment thread docs/contribute/publish-changelogs.md Outdated
@lcawl lcawl temporarily deployed to integration-tests May 20, 2026 13:56 — with GitHub Actions Inactive
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 win

Fix 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 the attrs_block extension 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 directly

Or, 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

📥 Commits

Reviewing files that changed from the base of the PR and between d4068f8 and 5a8712d.

📒 Files selected for processing (1)
  • docs/contribute/publish-changelogs.md

@lcawl lcawl merged commit 39f40a4 into main May 20, 2026
24 checks passed
@lcawl lcawl deleted the changelog-publish-docs branch May 20, 2026 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants