Skip to content

docs: move the changelog to the repo root - #498

Closed
lkdvos wants to merge 1 commit into
mainfrom
docs/changelog-root
Closed

docs: move the changelog to the repo root#498
lkdvos wants to merge 1 commit into
mainfrom
docs/changelog-root

Conversation

@lkdvos

@lkdvos lkdvos commented Aug 3, 2026

Copy link
Copy Markdown
Member

Split out of #449 so it can be reviewed on its own; independent of the documentation content.

A changelog is the first thing a contributor looks for in the repository, so keep the canonical copy at CHANGELOG.md where GitHub renders it, and have make.jl copy it into src/ at build time for the rendered page. The generated copy is gitignored so it cannot drift from the root file.

🤖 Generated with Claude Code

A changelog is the first thing a contributor looks for in the repository, so keep the
canonical copy at `CHANGELOG.md` where GitHub renders it, and have `make.jl` copy it into
`src/` at build time for the rendered page. The generated copy is gitignored so it cannot
drift from the root file.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@lkdvos

lkdvos commented Aug 3, 2026

Copy link
Copy Markdown
Member Author

Dropping the changelog migration — the changelog stays at docs/src/changelog.md.

#499 has been updated so that CONTRIBUTING.md and the PR template point contributors at that path rather than a root CHANGELOG.md. The branch docs/changelog-root is left in place if this is ever worth revisiting.

@lkdvos lkdvos closed this Aug 3, 2026
@codecov

codecov Bot commented Aug 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
see 1 file with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@lkdvos
lkdvos deleted the docs/changelog-root branch August 4, 2026 01:51
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