From 500316e50383c384126c7a4758c4129e5ea3879d Mon Sep 17 00:00:00 2001 From: lkdvos Date: Mon, 3 Aug 2026 13:07:59 -0400 Subject: [PATCH] docs: move the changelog to the repo root 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) --- docs/src/changelog.md => CHANGELOG.md | 0 docs/.gitignore | 3 ++- docs/make.jl | 3 +++ 3 files changed, 5 insertions(+), 1 deletion(-) rename docs/src/changelog.md => CHANGELOG.md (100%) diff --git a/docs/src/changelog.md b/CHANGELOG.md similarity index 100% rename from docs/src/changelog.md rename to CHANGELOG.md diff --git a/docs/.gitignore b/docs/.gitignore index 0587d7400..c5cc3ab56 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,4 +1,5 @@ build/ node_modules/ package-lock.json -Manifest.toml \ No newline at end of file +Manifest.toml +src/changelog.md \ No newline at end of file diff --git a/docs/make.jl b/docs/make.jl index 5922e4ee3..050917f5e 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -38,6 +38,9 @@ links = InterLinks( # include MPSKit in all doctests DocMeta.setdocmeta!(MPSKit, :DocTestSetup, :(using MPSKit, TensorKit); recursive = true) +# root CHANGELOG.md is canonical (visible on GitHub); copy it in for rendering +cp(joinpath(@__DIR__, "..", "CHANGELOG.md"), joinpath(@__DIR__, "src", "changelog.md"); force = true) + makedocs(; sitename = "MPSKit.jl", format = DocumenterVitepress.MarkdownVitepress(;