MitchellAcoustics / MitchellAcoustics/Soundscapy

Consolidate duplicate CHANGELOG files (root vs docs/)

Open
#142 0 comments 1 reaction 2 assignees View on GitHub

@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 releases
  • docs/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:

  1. Symlink docs/CHANGELOG.mdCHANGELOG.md, or
  2. Configure the docs build to reference the root file (e.g. via a mkdocs/zensical nav pointer or a docs/CHANGELOG.md that 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.