Skip to content

[DOCS] Edit changelog creation page#3170

Merged
lcawl merged 7 commits intomainfrom
changelog-edits1
Apr 29, 2026
Merged

[DOCS] Edit changelog creation page#3170
lcawl merged 7 commits intomainfrom
changelog-edits1

Conversation

@lcawl
Copy link
Copy Markdown
Contributor

@lcawl lcawl commented Apr 23, 2026

Relates to #3050

This PR cleans up the docs related to the creating changelogs.

@lcawl lcawl added the documentation Improvements or additions to documentation label Apr 23, 2026
@lcawl lcawl marked this pull request as ready for review April 29, 2026 01:17
@lcawl lcawl requested review from a team as code owners April 29, 2026 01:17
@lcawl lcawl requested a review from reakaleek April 29, 2026 01:17
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 29, 2026

Warning

Rate limit exceeded

@lcawl has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 53 minutes and 22 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 91ee4e62-40f9-4680-940a-f74caa8e7967

📥 Commits

Reviewing files that changed from the base of the PR and between b2d0b40 and 4132938.

📒 Files selected for processing (2)
  • docs/cli/changelog/add.md
  • docs/contribute/configure-changelogs-ref.md
📝 Walkthrough

Walkthrough

This pull request updates documentation across multiple changelog CLI-related pages. It restructures sections in the add and create-changelogs documentation, adds a new "Product format" reference section to the bundle documentation, consolidates configuration documentation with updated cross-references, and introduces new guidance covering GitHub authorization requirements and label strategy in setup documentation. Reference links throughout are updated to point to newly reorganized or consolidated documentation sections.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title '[DOCS] Edit changelog creation page' accurately describes the main focus of the changes, which involve editing documentation for creating changelogs across multiple related files.
Description check ✅ Passed The description is related to the changeset, mentioning it 'cleans up the docs related to the creating changelogs' and references issue #3050, which aligns with the documentation updates shown in the raw summary.
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-edits1

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
Review rate limit: 0/1 reviews remaining, refill in 53 minutes and 22 seconds.

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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/cli/changelog/add.md`:
- Line 181: Fix the typo in the documentation sentence that reads "If `--repo`
is specified (or `bundle.repo` is set in the changelog configuraiton file),..."
by replacing "configuraiton" with "configuration" so the text correctly
references the changelog configuration file; ensure the sentence continues to
mention `--repo`, `bundle.repo`, and `products.yml` exactly as shown.

In `@docs/contribute/configure-changelogs-ref.md`:
- Around line 188-189: The intro sentence for the pivot example in the changelog
docs has a duplicated verb and a typo: change "The following example contains
demonstrates some GitHub label mappings in the `pivot` section of the chaneglog
configuration file:" to a corrected form such as "The following example
demonstrates some GitHub label mappings in the `pivot` section of the changelog
configuration file:" (or use "contains" instead of "demonstrates") so remove the
duplicate verb and fix `chaneglog` to `changelog`.
🪄 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: 2062103b-24c4-4028-b20d-e72dbb3933d9

📥 Commits

Reviewing files that changed from the base of the PR and between f7641a5 and b2d0b40.

📒 Files selected for processing (6)
  • docs/cli/changelog/add.md
  • docs/cli/changelog/bundle.md
  • docs/contribute/bundle-changelogs.md
  • docs/contribute/configure-changelogs-ref.md
  • docs/contribute/configure-changelogs.md
  • docs/contribute/create-changelogs.md

Comment thread docs/cli/changelog/add.md Outdated
Comment thread docs/contribute/configure-changelogs-ref.md Outdated
lcawl and others added 2 commits April 28, 2026 18:23
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@lcawl lcawl enabled auto-merge (squash) April 29, 2026 01:24
@lcawl lcawl mentioned this pull request Apr 29, 2026
5 tasks
@lcawl lcawl merged commit 6045e51 into main Apr 29, 2026
24 checks passed
@lcawl lcawl deleted the changelog-edits1 branch April 29, 2026 01:33
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