Repository navigation
docs: bump comark-docs layer and lint docs content - #481
Merged
Merged
Conversation
- Pin the layer after comarkdown/comark-docs#79 and #80. - Replace the comark-docs patch with the new comarkDocs.highlighter option (Vitesse themes). - Rename the u-* content components the layer no longer registers globally. - 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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
👁️🗨️ Review this pull request with grouped, summarized diffs at: raw result💭 analyzed by {
"headSha": "9e5f5938348bba9ff05cfdcea5170526939b344a",
"result": {
"overallSummary": "This PR bumps the `comark-docs` layer pin and migrates the docs site's content to use its new, non-global component names and highlighter hook, adds content linting (`comark-lint`) wired into CI, and makes two unrelated supporting fixes: a `pnpm-workspace.yaml` trust-policy update needed for `pnpm install` to succeed, and a formatting fix in a test file so a lint rule doesn't block CI before the new docs lint step runs.",
"groups": [
{
"key": "docs-layer-bump",
"label": "Docs layer bump & lint",
"summary": "Moves the docs site to the current `comark-docs` layer pin, replaces the deleted patch with a layer-provided `highlighter` option (keeping Vitesse code block themes), switches content from the layer's now-removed global `u-*` components to local `::landing-hero`/`::button`/`::page-section` components, and adds a `comark-lint.config.ts` plus a `lint:docs` script wired into CI.",
"category": "docs",
"filePaths": [
"docs/nuxt.config.ts",
"docs/highlighter.ts",
"docs/app/components/global/PageSection.ts",
"docs/comark-lint.config.ts",
"docs/package.json",
"docs/content/4.ecosystem.md",
"docs/content/index.md",
"patches/comark-docs@0.0.1.patch",
"knip.jsonc",
"package.json",
".github/workflows/ci.yml"
],
"fileNotes": [
{
"path": "docs/comark-lint.config.ts",
"text": "Custom route validator accepts Vue-only pages, static `public/` files, and lowercases paths because comark-content lowercases page paths (e.g. `/errors/DF0036`)."
},
{
"path": "docs/highlighter.ts",
"text": "Replaces the deleted `patches/comark-docs@0.0.1.patch` by configuring the Vitesse Shiki themes through the layer's new `comarkDocs.highlighter` option instead of patching the layer."
},
{
"path": "knip.jsonc",
"text": "Adds the three new docs-only entry files (loaded by path, not import) so knip doesn't flag them as unused."
}
]
},
{
"key": "deps-workspace",
"label": "Deps & workspace trust",
"summary": "Bumps the `comark-docs` catalog pin and adds `comark`/`comark-linter`/`@shikijs/themes` dependencies for the docs changes, drops the now-unneeded patched dependency entry, and excludes three new Vercel package versions from trust policy checks that `pnpm install` otherwise rejects.",
"category": "deps",
"filePaths": [
"pnpm-lock.yaml",
"pnpm-workspace.yaml"
],
"critical": true,
"fileNotes": [
{
"path": "pnpm-workspace.yaml",
"text": "Adds `@vercel/functions@3.10.5`, `@vercel/oidc@4.0.5`, and `@vercel/cli-config@0.3.5` to `trustPolicyExclude` to unblock install; worth a sanity check that these are expected/trusted releases."
}
]
},
{
"key": "test-formatting",
"label": "Test formatting fix",
"summary": "Wraps two long object literals across multiple lines to satisfy the `antfu/reasonable-newline` lint rule, which would otherwise fail CI's `lint` step before it reaches the new `lint:docs` check.",
"category": "tests",
"filePaths": [
"packages/devframe/src/adapters/__tests__/initiate.test.ts"
]
}
],
"schemaVersion": 1,
"source": "llm",
"generatedAt": "2026-11-02T17:16:40.816Z",
"model": "vercel-ai-gateway/anthropic/claude-sonnet-5",
"locale": "en"
}
} |
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
Maintainer validation is needed because production rendering was not exercised locally and package provenance for three trust-policy exceptions remains unverified.
No open issues 🎉
What changed in this PR
Updates the docs site to the newer comark-docs layer and adds content linting to CI, while preserving Vitesse code highlighting without a dependency patch.
Changes:
- Upgrades the docs layer and configures highlighting through its supported option.
- Migrates content to the layer’s component names and adds a global page-section export.
- Adds docs lint configuration, scripts, and CI integration, plus formatting-only test changes.
| File | Description |
|---|---|
pnpm-workspace.yaml |
Updates the layer pin, docs dependencies, and trust exclusions; removes patch registration. |
patches/comark-docs@0.0.1.patch |
Deletes the superseded highlighting patch. |
packages/devframe/src/adapters/__tests__/initiate.test.ts |
Reformats two objects to satisfy lint rules. |
package.json |
Adds the root lint:docs command. |
knip.jsonc |
Registers path-loaded docs files as entries. |
docs/package.json |
Adds the content lint command and required dependencies. |
docs/nuxt.config.ts |
Points the docs layer to the custom highlighter. |
docs/highlighter.ts |
Configures Shiki with Vitesse light and dark themes. |
docs/content/index.md |
Migrates hero, button, and section component names. |
docs/content/4.ecosystem.md |
Migrates call-to-action buttons to the supported component name. |
docs/comark-lint.config.ts |
Extends the layer preset with local components and route handling. |
docs/app/components/global/PageSection.ts |
Exposes Nuxt UI’s page section to Markdown content. |
.github/workflows/ci.yml |
Runs docs linting in the CI lint step. |
Review effort: Balanced
This branch was successfully deployed
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.
Summary
This PR moves the docs site to the current
comark-docslayer and lints the docs content in CI.4fcfb4f(after fix: bump the content cache version and re-export Nuxt UI's button instead of global u- components comarkdown/comark-docs#79 and feat: add a highlighter option for content code blocks comarkdown/comark-docs#80).comarkDocs.highlighteroption.docs/highlighter.tssets the Vitesse themes through it, sopatches/comark-docs@0.0.1.patchis deleted. Code blocks look the same as on the live site.u-*components globally. Content now uses::landing-hero,::button, and::page-section.page-sectionis a one-line re-export indocs/app/components/global/PageSection.ts, the same pattern as the other global components.docs/comark-lint.config.tsextends the layer's lint preset with the site's global components and its routes. The routes accept the/chatand/logosVue pages, files inpublic/, and mixed-case paths such as/errors/DF0036, because comark-content lowercases page paths. A new rootlint:docsscript runscomark-lint, and the CIlintstep runs it.initiate.test.ts.mainfails theantfu/reasonable-newlinelint rule on them now, and that failure would stop the CI lint step before it reacheslint:docs.On the first run, the lint reported 170 broken links and 7 unknown components. All of them came from the cases above, not from wrong links in the content. Now it reports no problems.
pnpm installrefused 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.5are added totrustPolicyExclude.Verification
pnpm run lint:docs: No problems.pnpm run lint: no errors.pnpm run knip: no issues. The three new docs files are knip entries because Nuxt, the layer, and thecomark-lintCLI load them by path.pnpm run typecheck: 43 of 43 tasks pass.pnpm exec vitest run packages/devframe/src/adapters/__tests__/initiate.test.ts: 25 tests pass.pnpm docs:build: the build completes.nuxt dev:/,/ecosystem, and/guide/tutorial-server-data-inspectorrender with no rawu-*orlanding-herotags in the HTML./,/ecosystem,/guide/tutorial-server-data-inspector, and/errors/DF0036return 200, with no rawu-*orlanding-herotags and with Vitesse colors in the code blocks. When I checked,https://devfra.me/onmainreturned500 FUNCTION_INVOCATION_FAILED, so the landing page has no "before" image.Visual changes
Code blocks on
/guide/tutorial-server-data-inspectorlook the same as on devfra.me (Vitesse light and dark). Innuxt dev, the landing hero, the page section callout, and the ecosystem buttons render with Nuxt UI styles. I could not attach the screenshots from this environment, so @atinux has them.Written by an AI agent (Amp) on behalf of @atinux.