Skip to content

docs: close three gaps the 1.0.0 review left open - #195

Merged
simontaurus merged 1 commit into
mainfrom
docs/post-1-0-cleanup
Sep 27, 2026
Merged

simontaurus merged 1 commit into
mainfrom
docs/post-1-0-cleanup

Conversation

@simontaurus

Copy link
Copy Markdown
Contributor

Non-blocking findings from the pre-tag review, now that 1.0.0 is out.

  • docs/contributing.md states "Nothing is pushed to main directly" three sections above a release recipe that commits on main and tags it. The tag has to point at that commit, so the recipe is right and the rule needed the exception.
  • docs/migration/from-legacy-osw.md presents x-oold-reverse-default-properties as something a legacy schema migrates to. It was withdrawn from the vocabulary in 1.0.0-rc.4. Since nothing rejects it, a reader following that page produces a schema that validates and silently does nothing.
  • GOVERNANCE.md resolves maintainer disagreement through "the specification lead". No such role exists in MAINTAINERS.md, which assigns areas instead. Now points at the area.

One finding from the review is deliberately left: OOLD-EXT-9ee8 opens on "Such a tool" with no antecedent in its own sentence. Its text is hashed and shipped in 1.0.0, so rewording it is a catalogue change rather than a typo fix, and it reads correctly in the rendered specification where the preceding sentence is adjacent.

- contributing said nothing is pushed to main while the release recipe
  three sections below commits there
- the legacy-OSW migration named x-oold-reverse-default-properties as a
  migration target; it was withdrawn in rc.4
- governance gave a tie-break to a specification lead, a role
  MAINTAINERS.md does not name
@simontaurus
simontaurus merged commit 172d21b into main Sep 27, 2026
3 checks passed
@simontaurus
simontaurus deleted the docs/post-1-0-cleanup branch September 27, 2026 19:46
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