Conversation
We had the machinery and not the statement. Figshare mints a version DOI per deposit and the concept DOI resolves to the newest, so previous versions have always been retrievable -- but nothing in a note told a reader it had moved, or what moved. The one thing every correction policy agrees on is that a published article is never changed silently. So an updated note carries a `## History` section: one entry per DEPOSITED version, newest first, with the version, the date, the version DOI, what changed and -- when it applies -- what did not. That last part is the useful half when an API moved and the physics did not: it is what saves a reader from re-reading the note to find out. Only deposited versions appear. A typo fix is a patch bump with no deposit and leaves no trace, or the section fills with corrections nobody needs and the ones that matter are lost among them. The live page carries the current history and each deposited PDF carries the history up to its own version. That is correct rather than a defect, and it is why nothing goes back to amend an older PDF: a deposited copy is a fixed document, and the version DOIs are what connect them. A test notices a note deposited past 1.0.0 with no History section, since this is exactly the kind of step that gets forgotten. It found one immediately -- the browser note, deposited at 1.1.0 in August and silent about it -- which now has its entries. Underworld development team with AI support from Claude Code
Contributor
|
Preview Or the whole site. Built from |
Adding the section is a change to the note, so the version moves. It is a patch and is not redeposited, so it gets no History entry of its own -- only deposited versions do, or the section fills with self-reference. The outstanding report shows the note as ahead of its archival copy until the next deposit carries it, which is exactly what that line is for. Underworld development team with AI support from Claude Code
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
1 participant
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.
We had the machinery and not the statement. Figshare mints a version DOI per
deposit and the concept DOI resolves to the newest, so previous versions have
always been retrievable — but nothing in a note told a reader it had moved, or
what moved.
Every correction policy agrees on the same core: a published article is never
changed silently, the notice is dated, it is specific about what changed, and
neither the original nor the change is hidden.
The rule
An updated note carries a
## Historysection — one entry per depositedversion, newest first, with the version, the date, the version DOI, what changed
and, when it applies, what did not. That last part is the useful half when
an API moved and the physics did not: it saves a reader from re-reading the note
to find out.
Only deposited versions appear. A typo fix is a patch bump with no deposit and
leaves no trace, or the section fills with corrections nobody needs and the ones
that matter are lost among them.
The live page carries the current history; each deposited PDF carries the history
up to its own version. That is correct rather than a defect, and it is why
nothing goes back to amend an older PDF — a deposited copy is a fixed document,
and the version DOIs are what connect them.
Where it is written down
PUBLISHING.md(the rule and the example),CONTRIBUTING.md(one line in thestanding conventions), and a commented stub in the article template.
And a check, because this is a step that gets forgotten
A test flags any note deposited past
1.0.0with no History section. It foundone immediately:
running-underworld-in-a-browser, deposited at 1.1.0 on 31August and silent about it. Its entries are in this PR.
Underworld development team with AI support from Claude Code