Skip to content

Release 1.0.0 - #15

Merged
cudoment merged 1 commit into
mainfrom
release/1.0.0
Oct 27, 2026
Merged

cudoment merged 1 commit into
mainfrom
release/1.0.0

Conversation

@cudoment

Copy link
Copy Markdown
Owner

Bumps every package to 1.0.0, the first stable release, and pins the sibling dependencies to it. The release notes are in docs/release-notes.md and docs/release-notes.ko.md, under ## 1.0.0, including what to act on when upgrading.

  • From now on, the public imports, options, syntax, commands, diagnostic codes and stored formats the API reference documents change only in a major release.
  • Authors gain tabs (tab="…" fences, > [!TAB] blockquotes and each host's own tabs), code block titles and highlighted lines, variables, shared link references, merged table cells and table notes. Every syntax feature also takes off.
  • cudoc check reads tables from the source, links that only a case-insensitive disk resolves, variables, shared references, table notes and absolute links to the site's own origins, and names the closest real target. cudoc lsp runs the same check as a language server.
  • Collection writes pages.json and, with imageSizes, images.json. An exported site page carries a description and, with siteUrl, a canonical address, hreflang translations and a sitemap. A PDF links its sibling files relatively instead of by the printing machine's absolute path.
  • The documentation site publishes every host example under demos/, and the supported versions record what a new project installed on the checked date resolved to. Nextra is supported on 4.6.0, which the guide recommends, and on 4.6.1 with zod pinned below 4.4.
  • cudoc needs Node.js 22 or later, and CI runs on 22, 24 and 26. The advisories reported since 0.9.0 are fixed with compatible releases or tabled in examples/README.md. CONTRIBUTING and SECURITY are added in both languages, and a writing test holds every published page to the rules CONTRIBUTING gives.

Verified on the release machine: npm ci, npm run build (and build:webpack in next-mdx) and npm audit in each of the six examples (Next.js, Docusaurus, Eleventy and export report nothing; the Nextra and VitePress findings are the ones tabled in examples/README.md), npm run format:check, npm run typecheck, CUDOC_STRICT=1 npm test (88 files, 2711 tests) and npm run test:scripts (all five, including the guide check and the comparison of the 75 export samples). An independent review of the documentation changed since the last full review found five corrections to the Nextra advice and the README comparison table. They are applied, and the formatting check and the integration tests (19 files, 1294 tests) pass again.

Every package is already on npm with a trusted publisher for this repository and publish.yml, so the whole release goes out from the workflow.

1.0.0 is the first stable release. The public imports, options,
syntax, commands, diagnostic codes and stored formats the API
reference documents now change only in a major release.

Authors gain tabs, from `tab="…"` fences, `> [!TAB]` blockquotes or
each host's own tabs, code block titles and highlighted lines, one
table of `variables`, shared link references, merged table cells and
table notes. Every syntax feature also takes `off`, which leaves its
text as written.

`cudoc check` reads tables from the source, links that only a
case-insensitive disk resolves, variables, shared references, table
notes and absolute links to the site's own origins, and names the
closest real target. `cudoc lsp` runs the same check as a language
server.

Collection writes `pages.json` and, with `imageSizes`, `images.json`.
An exported site page carries a description and, with `siteUrl`, a
canonical address, its translations and a sitemap. A PDF links its
sibling files relatively, since the browser wrote each link as an
absolute file URL into the staging directory of the machine that
printed it.

The documentation site publishes every host example under `demos/`,
and the supported versions record what a new project installed on the
checked date resolved to. Nextra is supported on the releases that
build: 4.6.0, which the guide recommends, and 4.6.1 with zod pinned
below 4.4.

cudoc needs Node.js 22 or later, and CI runs on 22, 24 and 26. The
advisories reported since 0.9.0 are fixed with compatible releases or
tabled in examples/README.md. CONTRIBUTING and SECURITY say how to
contribute and how to report a vulnerability, and a writing test holds
every published page to the rules CONTRIBUTING gives.

Every package moves to 1.0.0 with its siblings pinned to it, the root
and example lockfiles follow, and the export samples are rebuilt with
the new generator version. The release notes list what to act on when
upgrading.
@cudoment
cudoment merged commit c694648 into main Oct 27, 2026
6 checks passed
@cudoment
cudoment deleted the release/1.0.0 branch October 27, 2026 06:45
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