Hypermedia release notes graph

[richlander]

Rendered

The .NET project has published release notes in JSON and markdown for many years. There are challenging aspects of the current scheme that could benefit from a new approach. A new from-scratch approach is needed to resolve its problems. The new approach leans heavily on hypermedia both as inspiration and actual format to push us towards a strong and proven design paradigm.

The two major problems with the entrypoint JSON document:

• It needs to be updated every month (with downstream implications) by virtue of its schema.
• It references large monolithic documents that are problematic for multiple scenarios

Prototype entrypoints for graph:

• https://raw.githubusercontent.com/dotnet/core/refs/heads/release-index/llms.txt
• https://raw.githubusercontent.com/dotnet/core/refs/heads/release-index/release-notes/llms.json
• https://raw.githubusercontent.com/dotnet/core/refs/heads/release-index/release-notes/index.json

The first two entrypoints are for LLMs and the last for tools as the intended replacement for releases-index.json.

Related:

• Updating release notes publishing core#10143
• Exposing Hypermedia Information Graphs to LLMs #359

[leecow]

Should it be explained that major version is deliberately combining major.minor?

[richlander]

Done.