Skip to content

v3 -> v4 changes - #143

Draft
meldra wants to merge 1 commit into
codemeta:masterfrom
meldra:update-v3-v4
Draft

meldra wants to merge 1 commit into
codemeta:masterfrom
meldra:update-v3-v4

Conversation

@meldra

@meldra meldra commented Sep 12, 2026

Copy link
Copy Markdown
Contributor

This change adds a badge shortcode built based on the supported versions config added recently. It will help reduce the number of places the version number needs updating. Sadly, adding shortcodes to codeblocks ruins their formatting.

The badge has been added to the json-ld page to replace the existing badge there, and has also been added to the tools page to further emphasize the latest version as described in #122. It was also added to the context section of the user guide.

The user guide retains links to real-world examples using old versions towards the end of the document. An admonition has been added under the examples links to prompt people to check and not copy it verbatim without due care.

This change adds a `badge` shortcode built based on the supported
versions config added recently. It will help reduce the number of
places the version number needs updating. Sadly, adding shortcodes
to codeblocks ruins their formatting.

The badge has been added to the json-ld page to replace the existing
badge there, and has also been added to the tools page to further
emphasize the latest version as described in codemeta#122. It was also added
to the context section of the user guide.

The user guide retains links to real-world examples using old
versions towards the end of the document. An admonition has been
added under the examples links to prompt people to check and not
copy it verbatim without due care.
@meldra

meldra commented Sep 12, 2026

Copy link
Copy Markdown
Contributor Author

At some point, we need to decide what version string format we want to stick with in the content (with perhaps the context URLS being excepted of course) and be consistent.

The updates this round have kept the formats consistent with the contexts they were in, for example on the tools page, which uses a 3.0.0 format, and uses it to refer to anything in the v3.x version family.

As far as I can tell, there is not an in-use version that uses the last segment of that format.

@meldra

meldra commented Sep 12, 2026

Copy link
Copy Markdown
Contributor Author

uses a 3.0.0 format, and uses it to refer to anything in the v3.x version family.

To be clear, this doesn't really make sense to me. This is a discussion for the community though.

@meldra

meldra commented Sep 12, 2026

Copy link
Copy Markdown
Contributor Author

Draft until v4 officially released

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant