Skip to content

add CHANGELOG.md#79

Merged
jameslamb merged 1 commit intorapidsai:mainfrom
jameslamb:docs/changelog
Mar 11, 2026
Merged

add CHANGELOG.md#79
jameslamb merged 1 commit intorapidsai:mainfrom
jameslamb:docs/changelog

Conversation

@jameslamb
Copy link
Member

Contributes to #13

After rapidsai/docs#755, nvForest docs are now live on the docs site: https://docs.rapids.ai/api/

The RAPIDS docs site code automatically adds a link to CHANGELOG.md for each project, expected to be at the repo root. This project doesn't have one yet, so that link is broken.

This adds a minimal CHANGELOG.md file to fix that.

@jameslamb jameslamb requested review from csadorf and hcho3 March 11, 2026 14:35
@jameslamb jameslamb requested a review from a team as a code owner March 11, 2026 14:35
@jameslamb jameslamb requested a review from gforsyth March 11, 2026 14:35
@jameslamb jameslamb added doc Improvements or additions to documentation non-breaking Introduces a non-breaking change labels Mar 11, 2026
@coderabbitai
Copy link

coderabbitai bot commented Mar 11, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Chores
    • Updated CHANGELOG to document nvForest's initial public development timeline.

Walkthrough

Adds a changelog entry documenting nvForest's initial public development milestone in March 2026. This is a straightforward documentation update with minimal scope.

Changes

Cohort / File(s) Summary
Documentation Update
CHANGELOG.md
Added entry marking the start of nvForest's initial public development in March 2026.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding a CHANGELOG.md file to the repository.
Description check ✅ Passed The description clearly explains the context and purpose of adding CHANGELOG.md to fix a broken link on the RAPIDS docs site.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Copy link

@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.

🧹 Nitpick comments (1)
CHANGELOG.md (1)

1-3: Use a conventional changelog structure here.

This fixes the broken link, but the current content reads like a one-off note rather than a changelog. Renaming the top heading to # Changelog and adding this as a dated entry would make future additions much easier and better match what readers expect from a CHANGELOG.md.

♻️ Suggested structure
-# nvForest initial public development (March 2026)
-
-Public development on nvForest began in March 2026.
+# Changelog
+
+## March 2026
+
+- Public development on nvForest began.

As per coding guidelines, documentation changes should prioritize clarity and consistency.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` around lines 1 - 3, Replace the current top heading text "#
nvForest initial public development (March 2026)" with a conventional "#
Changelog" heading, and convert the existing sentence "Public development on
nvForest began in March 2026." into a dated entry under the changelog (e.g., "##
2026-03 - Initial public development: Public development on nvForest began in
March 2026."), so the file follows a standard changelog structure and is ready
for future entries.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CHANGELOG.md`:
- Around line 1-3: Replace the current top heading text "# nvForest initial
public development (March 2026)" with a conventional "# Changelog" heading, and
convert the existing sentence "Public development on nvForest began in March
2026." into a dated entry under the changelog (e.g., "## 2026-03 - Initial
public development: Public development on nvForest began in March 2026."), so
the file follows a standard changelog structure and is ready for future entries.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 55c50583-5a3a-4be0-b56c-3a10a7af89e6

📥 Commits

Reviewing files that changed from the base of the PR and between ea0302b and 39b1f74.

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

@jameslamb
Copy link
Member Author

I'm admin-merging this one based on @hcho3 's approval + the passing CI, don't think packaging-codeowners really needs to be involved in this one.

@jameslamb jameslamb merged commit 5a29d01 into rapidsai:main Mar 11, 2026
61 checks passed
@jameslamb jameslamb deleted the docs/changelog branch March 11, 2026 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants