docs: add changelog to the website - #337
Merged
Merged
Conversation
Publish docs/changelog.md as /docs/changelog.html, list it under Project in the docs sidebar, and link it from the landing header. Amp-Thread-ID: https://ampcode.com/threads/T-01a0a631-f6de-735d-b395-b45d281f927e Co-authored-by: Max Carter <undivisible@vk.com>
|
Capy couldn't review this pull request because Max's workspace is out of credits, add credits or enable auto-reload to resume automatic reviews. |
Bugbot couldn't run - usage limit reachedBugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit. A user or team admin can review and increase usage limits in the Cursor dashboard. (requestId: serverGenReqId_04c47650-7606-4c29-b3de-e3a436d664fc) |
|
Tick the box to add this pull request to the merge queue (same as
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The public site had no changelog. Releases (0.9.8 crates.io + GitHub binaries) were only visible on GitHub/crates.io.
What
docs/changelog.md(0.9.8 current, 0.9.7 skipped, earlier 0.9.x).docs/README.mdand[targets.llms]./docs/changelog.htmland the homepage link.bun testin docs-site: 8 pass.Note
Low Risk
Documentation, navigation, and test-only changes with no compiler or runtime behavior impact.
Overview
Adds a public changelog so crate and GitHub binary releases are documented on the site, not only on GitHub/crates.io.
New
docs/changelog.mdcovers 0.9.8 (current) through earlier 0.9.x and notes the skipped 0.9.7 publish. It is wired into the docs build via a Project → Changelog sidebar entry indocs-gen, listed indocs/README.md, and included in[targets.llms]for LLM indexing. The landing page header gains a Changelog link to./docs/changelog.html.A dist test asserts
docs/changelog.htmlis generated with the doc shell (including the Project nav section and0.9.8) and that the homepage links to it.Reviewed by Cursor Bugbot for commit 75e9ac0. Configure here.