github-starred/cs249r_book
2
0
Fork 0
mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-04-30 09:38:38 -05:00
Code Issues 77 Packages Projects Releases 24 Wiki Activity

refactor: deprecate CHANGELOG.md in favor of GitHub Releases

Browse Source 
- Remove CHANGELOG.md from repo root
- Remove changelog.qmd page from book frontmatter
- Remove changelog from navbar in HTML, PDF, and EPUB configs
- Delete changelog generation scripts (generate_release_content.py, etc.)
- Update documentation to remove changelog references

GitHub Releases now serves as the primary changelog for version updates.
The version number in the navbar already links to releases.
This commit is contained in:
Vijay Janapa Reddi
2026-01-06 11:31:35 -05:00
parent f20ee89dea
commit 8160d5869c
11 changed files with 7 additions and 4951 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
book/docs/CONTRIBUTING.md
View File

@@ -55,8 +55,6 @@ Make your changes to the code or documentation. Please make sure that your chang
- Each chapter folder also include an images folder. The images folder has 4 subfolders: `png`, `pdf`, `svg`, and `jpg`. Please add your images to the appropriate folder. This is important to keep the images organized and to make sure that the images are rendered correctly in the book.
- Update `updates.md` file with a brief description of your contribution. Please include the issue number in the description. For example, `Fix typo in the documentation (issue #14)`. See [keep a changelog](https://keepachangelog.com/en/1.1.0/) for more information on how to write a good changelog.
### Commit your changes
```bash