Skip to content

docs: bump comark-docs layer and lint docs content - #107

Merged
antfu merged 2 commits into
mainfrom
docs/comark-docs-layer
Nov 3, 2026
Merged

antfu merged 2 commits into
mainfrom
docs/comark-docs-layer

Conversation

@atinux

@atinux atinux commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

This PR moves the docs site to the current comark-docs layer and lints the docs content in CI.

The lint found 7 links that the bump breaks. The new layer gives a nested heading its own slug, for example #baseline, not #x18n-check-baseline. The links to /surfaces/cli#x18n-check-baseline, #x18n-check-reporters, /plugins/yaml#sections-placeholders and #sections-scanners now use the new ids. Three are in hand-written pages, and four come from docs/scripts/generate.ts and docs/scripts/notes.ts, so the generated pages are regenerated.

The bump also stops two kinds of icons from rendering. The old layer fetched any icon from the Iconify API. The new layer serves only installed collections. @iconify-json/bxl (the VS Code logo) and @iconify-json/circle-flags (the locale flags in the demos) are not installed. catppuccin worked only through another package. This PR adds the three collections to docs/package.json and to icon.serverBundle.collections. The flags need the server bundle because their names come from data (i-circle-flags-${flag}), so the client bundle scan does not find them.

pnpm install refused three Vercel packages with "High-risk trust downgrade", so @vercel/functions@3.10.5, @vercel/oidc@4.0.5, and @vercel/cli-config@0.3.5 are added to trustPolicyExclude. They are published from vercel/vercel through npm trusted publishing, with no provenance attestation.

Verification

  • pnpm run lint:docs: No problems. Before the fixes: 7 broken anchors and 10 unknown-component reports for the three site components.
  • pnpm lint, pnpm knip: no issues.
  • pnpm typecheck: 15 of 15 tasks pass.
  • pnpm test --run (builds first): 808 tests in 59 files pass.
  • x18n check --strict: no errors.
  • pnpm -C docs run docs:build: the build completes.
  • nuxt dev: / has no raw u-* or landing-hero tags. The 7 links point to #baseline, #reporters, #placeholders and #scanners, and the target pages have those ids. Clicking the link on /surfaces/ci opens /surfaces/cli#baseline at the Baseline heading.
  • nuxt dev, Interactive UI and VS Code tabs: the bxl, circle-flags and catppuccin icons render, the same as on x18n.dev. Without the icon change, the VS Code logo and the five flags were empty.
  • Vercel preview of this PR: / renders the hero with no raw u-* or landing-hero tags. /surfaces/cli and /plugins/yaml have the baseline, reporters, placeholders and scanners ids. /api/_nuxt_icon serves the circle-flags, bxl and catppuccin icons that the demos use.

pnpm -C docs run generate in my environment also reorders the "Source" lists of docs/content/7.errors/x18n2002.md to x18n2004.md. sourceFiles() keeps readdir order, which depends on the file system. Those changes are not in this PR.

Written by an AI agent (Amp) on behalf of @atinux.

- Pin the layer after comarkdown/comark-docs#79 and #80.
- Rename the u-* content components the layer no longer registers globally.
- Fix 7 links to heading ids that the new layer no longer generates.
- Serve the bxl, catppuccin and circle-flags icons, which the layer no longer fetches from Iconify.
- Add comark-lint.config.ts and run comark-lint in CI through lint:docs.

Amp-Thread-ID: https://ampcode.com/threads/T-01a18c64-cf17-72b6-afc0-24d664666b30
@vercel

vercel Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
x18n Ready Ready Preview Nov 2, 2026 10:33pm UTC

@antfu
antfu merged commit dd4362a into main Nov 3, 2026
13 checks passed
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.

2 participants