MitchellAcoustics / MitchellAcoustics/Soundscapy
Consolidate duplicate CHANGELOG files (root vs docs/)
Open
@MitchellAcoustics is already working on this.
Since May 10, 2026.
- #143 by @copilot-swe-agent — open
documentation
- Dominant language
- Python
- Stars
- 59
- Forks
- 12
- PR merge metrics
- No merged PRs in 30d
Description
Problem
There are currently two CHANGELOG.md files maintained separately:
CHANGELOG.md(project root) — used by PyPI / GitHub releasesdocs/CHANGELOG.md— rendered in the documentation site
These are manually kept in sync, which is error-prone. For example, the root file was missing the 0.8.3 entry and the unreleased content added in the docs overhaul branch until it was added manually as part of the v0.8.4 release prep.
Proposal
Pick a single source of truth and either:
- Symlink
docs/CHANGELOG.md→CHANGELOG.md, or - Configure the docs build to reference the root file (e.g. via a mkdocs/zensical
navpointer or adocs/CHANGELOG.mdthat just--8<---includes the root file).
Notes
- Do this in a dedicated PR so the history is clean.
- Ensure the docs site still renders the changelog correctly after the change.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.