Skip to content

Include change log in documentation - #178

Merged
rlskoeser merged 1 commit into
developfrom
feature/docs-changelog
Jul 30, 2026
Merged

Include change log in documentation#178
rlskoeser merged 1 commit into
developfrom
feature/docs-changelog

Conversation

@rlskoeser

@rlskoeser rlskoeser commented Jul 30, 2026

Copy link
Copy Markdown
Member

Summary by CodeRabbit

  • Documentation
    • Added the changelog to the documentation site.
    • Linked the documentation changelog directly to the repository’s main changelog for centralized, up-to-date release information.

@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5e889633-8928-4674-81ce-be195b1a6f4f

📥 Commits

Reviewing files that changed from the base of the PR and between 946ecca and 48be3f0.

📒 Files selected for processing (2)
  • docs/CHANGELOG.md
  • docs/index.rst

Walkthrough

The documentation changelog page now includes the repository-level changelog, and docs/index.rst adds that page to the Sphinx toctree.

Changes

Documentation integration

Layer / File(s) Summary
Changelog page and navigation
docs/CHANGELOG.md, docs/index.rst
The documentation changelog includes ../CHANGELOG.md, and the Sphinx toctree exposes it as CHANGELOG.

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

Possibly related PRs

Poem

A bunny hops through docs so bright,
The changelog joins the page tonight.
One include, one path in view,
Sphinx finds the updates too.
Carrots cheer the tidy flight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main change: adding the changelog to the documentation.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/docs-changelog

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.

@rlskoeser
rlskoeser merged commit 3ceaaa4 into develop Jul 30, 2026
10 checks passed
@rlskoeser
rlskoeser deleted the feature/docs-changelog branch July 30, 2026 17:37
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.

1 participant