Repository navigation
Release 1.0.0 - #15
Merged
Merged
Conversation
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.
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
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.
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.mdanddocs/release-notes.ko.md, under## 1.0.0, including what to act on when upgrading.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 takesoff.cudoc checkreads 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 lspruns the same check as a language server.pages.jsonand, withimageSizes,images.json. An exported site page carries a description and, withsiteUrl, a canonical address,hreflangtranslations and a sitemap. A PDF links its sibling files relatively instead of by the printing machine's absolute path.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.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(andbuild:webpackinnext-mdx) andnpm auditin each of the six examples (Next.js, Docusaurus, Eleventy and export report nothing; the Nextra and VitePress findings are the ones tabled inexamples/README.md),npm run format:check,npm run typecheck,CUDOC_STRICT=1 npm test(88 files, 2711 tests) andnpm 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.