Skip to content

docs: add changelog nav link and trim history page - #54

Merged
swarna1101 merged 2 commits into
mainfrom
fix/docs-version-history-nav
Aug 6, 2026
Merged

docs: add changelog nav link and trim history page#54
swarna1101 merged 2 commits into
mainfrom
fix/docs-version-history-nav

Conversation

@swarna1101

@swarna1101 swarna1101 commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated the changelog to make version 1.1.1 the latest release.
    • Added supported-version listings and release-note links for versions 1.1.1 and 1.0.2.
    • Clarified version 1.0.2 deprecation messaging.
    • Replaced outdated upgrade instructions and historical release notes with current guidance.

@swarna1101
swarna1101 requested a review from a team as a code owner August 6, 2026 14:01
@swarna1101
swarna1101 requested a review from hpsing August 6, 2026 14:01
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: getoptimum/coderabbit/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: f1350dcc-52d4-456f-8416-5108360f2cc9

📥 Commits

Reviewing files that changed from the base of the PR and between 24c643a and 2901253.

📒 Files selected for processing (1)
  • docs/CHANGELOG.md

📝 Walkthrough

Walkthrough

The changelog now lists v1.1.1 as the latest release. It adds supported-version status and release-note links for v1.1.1 and v1.0.2. It directs users from the v1.0.2 deprecation notice to v1.1.1. It replaces obsolete RC10, RC11, and RC12 upgrade instructions with current upgrade guidance.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: hpsing

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title describes the documentation change but does not include the required domain or package scope. Add the domain or package scope, for example: docs(changelog): add navigation link and trim history page
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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/CHANGELOG.md`:
- Around line 39-41: Update the v1.0.2 upgrade guidance in the changelog to
match the v1.1.1 release notes: separate v1.0.2 partners from v1.1.1 partners,
require the applicable configuration field renames, and require identity volumes
at /tmp/libp2p and /tmp/mump2p for v1.0.2 upgrades. Remove the inaccurate “same
ports, volumes, and config” wording and keep the deprecated RC guidance
consistent with the repository’s documented migration steps.
🪄 Autofix

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: Repository: getoptimum/coderabbit/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 82c35c62-2cad-4000-bf01-9df4babf7f3d

📥 Commits

Reviewing files that changed from the base of the PR and between 8e6de55 and 24c643a.

⛔ Files ignored due to path filters (1)
  • docs/.vitepress/config.mts is excluded by none and included by none
📒 Files selected for processing (1)
  • docs/CHANGELOG.md

Comment thread docs/CHANGELOG.md
@swarna1101
swarna1101 merged commit df3bbed into main Aug 6, 2026
10 checks passed
@swarna1101
swarna1101 deleted the fix/docs-version-history-nav branch August 6, 2026 14:17
@coderabbitai coderabbitai Bot mentioned this pull request Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants