Skip to content

docs: link the implementations list and align the version declaration example #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johannschopplich merged 4 commits into from
Oct 2, 2026
Merged

docs: link the implementations list and align the version declaration example #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a3258e4
docs: align the versioning example with the §13 declaration
johannschopplich Sep 30, 2026
d04cacf
chore: match the §9.3 heading in the clarification template
johannschopplich Sep 30, 2026
df977d2
chore: drop the stale line-range example from the clarification template
johannschopplich Oct 1, 2026
1616a70
docs: link the implementations list from the readme
johannschopplich Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/clarification.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@ body:
label: Specification Section
description: Which section(s) are you asking about?
placeholder: |
E.g., Section 9.3, "Arrays of Objects — Tabular Form"
Or: SPEC.md:383-408
E.g., Section 9.3, "Arrays of Objects – Tabular Form"
validations:
required: true

Expand Down
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ The TOON specification uses MAJOR.MINOR versioning. See [VERSIONING.md](./VERSIO
- **Test Fixtures:** [tests/fixtures/](./tests/fixtures/) – Reference test fixtures
- **Changelog:** [CHANGELOG.md](./CHANGELOG.md) – Version history and changes
- **Reference Implementation:** [github.com/toon-format/toon](https://github.com/toon-format/toon) – TypeScript/JavaScript implementation
- **Implementations:** [toonformat.dev/ecosystem/implementations](https://toonformat.dev/ecosystem/implementations) – Official and community ports
- **Benchmarks:** [Reference repo benchmarks/](https://github.com/toon-format/toon/tree/main/benchmarks) – Token efficiency measurements and accuracy retrieval tests

## License
Expand Down
2 changes: 1 addition & 1 deletion VERSIONING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ If we need to make a breaking change (MAJOR version bump):

When in doubt, we err on the side of caution and treat potentially breaking changes as MAJOR version bumps.

Implementations should document the supported spec version (e.g. `"toon-spec": "3.2"`) and may support multiple versions concurrently: default to the latest, let users target a specific version, and document version-specific behavior. A new MINOR version keeps existing conformant implementations conformant. A new MAJOR version may require updates; previous-version implementations remain valid, and its CHANGELOG.md entry carries the migration guidance. A MINOR version that renames or retires a public concept handle (for example an option name) carries a migration note in CHANGELOG.md naming the old and new spelling.
Implementations should document the supported spec version (e.g., `toon-spec: 4.1`, as in SPEC.md §13) and may support multiple versions concurrently: default to the latest, let users target a specific version, and document version-specific behavior. A new MINOR version keeps existing conformant implementations conformant. A new MAJOR version may require updates; previous-version implementations remain valid, and its CHANGELOG.md entry carries the migration guidance. A MINOR version that renames or retires a public concept handle (for example an option name) carries a migration note in CHANGELOG.md naming the old and new spelling.

## Version History

Expand Down
Loading