docs: convert OpenAPI version support note to GitHub footnote - #106
Merged
Conversation
Copilot created this pull request from a session on behalf of
dotkas
August 13, 2026 11:50
View session
dotkas
marked this pull request as ready for review
August 13, 2026 11:50
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the README’s OpenAPI version support note by converting the prose line after the version table into a GitHub-flavored Markdown footnote, aiming to reduce visual clutter around the table.
Changes:
- Adds a footnote reference (
[^openapi-versions]) below the OpenAPI version support table. - Converts the existing maintenance/provenance note into a footnote definition (
[^openapi-versions]: ...).
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: dotkas <25500117+dotkas@users.noreply.github.com>
dotkas
force-pushed
the
copilot/update-readme-markdown-footnote
branch
from
August 13, 2026 11:54
1415014 to
ee684bb
Compare
dotkas
enabled auto-merge (squash)
August 13, 2026 11:54
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (2)
README.md:68
- Putting the footnote reference inside the heading changes the rendered heading text and can change the generated GitHub anchor/ToC entry, which may break existing links to this section. Keep the heading stable and attach the footnote reference in the body text instead (e.g., at the end of the intro paragraph before the table).
### OpenAPI Version Support [^openapi-versions]
Adding full support to all OpenAPI versions is not trivial, and is done in iterations which all require various design
decisions to support.
README.md:76
- The new footnote definition is a single very long line, which makes future diffs harder to read and is inconsistent with the surrounding hard-wrapped Markdown style in this README. Wrap the footnote definition across multiple indented continuation lines so it remains a single footnote block.
[^openapi-versions]: This table and the tracking issues are maintained automatically by the [OpenAPI version check workflow](.github/workflows/check-openapi-versions.yml), which probes the [upstream spec releases](https://github.com/OAI/OpenAPI-Specification/releases) against [`.github/openapi-versions.json`](.github/openapi-versions.json).
Contributor
|
🎉 This PR is included in version 1.0.0-dev.39 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Contributor
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Converts the trailing prose sentence below the OpenAPI version support table into a proper GitHub-flavoured Markdown footnote (
[^openapi-versions]), keeping the information without cluttering the table's visual flow.