# Consolidated page for organizing release notes

**URL:** https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832
**Category:** Development
**Created:** [August 28, 2023, 7:41pm UTC](https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832 "2023-08-28T19:41:10Z")
**Posts on this page:** 5
**Page:** 1

<div class="post-metadata">

### Author: ![jcfr](https://discourse.cmake.org/user_avatar/discourse.cmake.org/jcfr/32/80_2.png) [@jcfr](https://discourse.cmake.org/u/jcfr)
#### Post date: [August 28, 2023, 7:41pm UTC](https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832/1 "2023-08-28T19:41:10Z")

</div>

The release notes for each version are currently independently available at [https://cmake.org/cmake/help/latest/release/index.html](https://cmake.org/cmake/help/latest/release/index.html)

**Question:** How we we feel about adding a condolidated page with all the release notes aggregated ?

_Poll ([view on site](https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832/1))_

cc: @craig.scott @marc.chevrier @brad.king

* * *

**Rational**

When I am not sure about the exact version introducing a specific feature or fix, I often end up doing one of these:

1. opening release notes page for recent version and searching through them
2. locally searching through the directory `CMake/Help/release` of the source tree

This post discuss how to improve the status quo to provide a more useful release notes page.

---

<div class="post-metadata">

### Author: ![craig.scott](https://discourse.cmake.org/user_avatar/discourse.cmake.org/craig.scott/32/20_2.png) [@craig.scott](https://discourse.cmake.org/u/craig.scott)
#### Post date: [August 29, 2023, 6:41am UTC](https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832/2 "2023-08-29T06:41:07Z")

</div>

I can see advantages of both. If we do change to a consolidated set of release notes, we would want to have an index at the top for easy navigation. The policies page is a consolidated summary page, and sometimes I find it to be getting harder to work with as it grows longer. I also find it useful to be able to scan the full list of policies though, so I expect we’d have a similar situation with the release notes.

---

<div class="post-metadata">

### Author: ![ben.boeckel](https://discourse.cmake.org/letter_avatar_proxy/v4/letter/b/ea5d25/32.png) [@ben.boeckel](https://discourse.cmake.org/u/ben.boeckel)
#### Post date: [August 29, 2023, 2:12pm UTC](https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832/3 "2023-08-29T14:12:20Z")

</div>

I would like both. If the consolidated is collated by version, it is less useful than the per-version ones (e.g., if I’m looking for what I can do in that version). But if it is grouped more like an index (using Markdown because I can never remember reST syntax without highlighting support):

```md
## Ninja

- support for Fortran (since 3.X)
- support for job pools (since 3.Y)
- optimized dependencies (since 3.Z)

```

then I can use it to see for each category what version I might want to target.

---

<div class="post-metadata">

### Author: ![kyle.edwards](https://discourse.cmake.org/letter_avatar_proxy/v4/letter/k/65b543/32.png) [@kyle.edwards](https://discourse.cmake.org/u/kyle.edwards)
#### Post date: [August 29, 2023, 2:31pm UTC](https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832/4 "2023-08-29T14:31:38Z")

</div>

I would like to see the addition of a consolidated page while also keeping the paginated version that we have right now, in order to get the best of both worlds.

---

<div class="post-metadata">

### Author: ![craig.scott](https://discourse.cmake.org/user_avatar/discourse.cmake.org/craig.scott/32/20_2.png) [@craig.scott](https://discourse.cmake.org/u/craig.scott)
#### Post date: [August 29, 2023, 8:42pm UTC](https://discourse.cmake.org/t/consolidated-page-for-organizing-release-notes/8832/5 "2023-08-29T20:42:25Z")

</div>

Here’s an example of a consolidated page which also provides a table of contents in the sidebar to aid navigation:

[https://ccache.dev/releasenotes.html](https://ccache.dev/releasenotes.html)

Because the table of contents is in a sidebar, it doesn’t scroll when you scroll the main body, so it always remains easily accessible.
