Skip to content

Add CHANGELOG, RELEASE_NOTES, and expand README#15

Open
pambrose wants to merge 1 commit into
masterfrom
add-project-docs
Open

Add CHANGELOG, RELEASE_NOTES, and expand README#15
pambrose wants to merge 1 commit into
masterfrom
add-project-docs

Conversation

@pambrose

@pambrose pambrose commented Jul 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds project documentation covering the repository's full history, from the April 2020 initial release through the present.

  • CHANGELOG.md (new) — Keep a Changelog style, grouped by date/milestone since the repo has never used version tags. Includes an [Unreleased] section for the pending JVM 25 and dependency/toolchain bumps currently in the working tree.
  • RELEASE_NOTES.md (new) — narrative summary of the major milestones (2026 content expansion & DX overhaul, 2024–2025 build modernization, 2021–2023 maintenance, the late-2020 test suite, and the 2020 initial release).
  • README.md (expanded) — adds the content catalog (25 groups / 200+ challenges), Makefile targets, project layout, tech stack, testing, and cross-links to the new docs.

Notes

  • No version tags exist in the repo, so the changelog is keyed to dates and readingbat-core milestones rather than invented semantic versions.
  • The JVM 25 bump and dependency upgrades are uncommitted working-tree changes, so they appear only under [Unreleased]; they are not part of this PR.
  • This PR contains documentation only — no build or dependency changes.

🤖 Generated with Claude Code

Document the repository's full history from the April 2020 initial
release through the present. The changelog is grouped by date/milestone
since the repo has never used version tags, with an Unreleased section
for pending dependency and toolchain bumps. RELEASE_NOTES summarizes the
major milestones in narrative form, and README is expanded with the
content catalog, project layout, and cross-links to both new docs.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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