Skip to content

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

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

atinux 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 layer pin moves to 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).
  • The layer now has a comarkDocs.highlighter option. docs/highlighter.ts sets the Vitesse themes through it, so patches/comark-docs@0.0.1.patch is deleted. Code blocks look the same as on the live site.
  • The layer no longer registers the Nuxt UI u-* components globally. Content now uses ::landing-hero, ::button, and ::page-section. page-section is a one-line re-export in docs/app/components/global/PageSection.ts, the same pattern as the other global components.
  • docs/comark-lint.config.ts extends the layer's lint preset with the site's global components and its routes. The routes accept the /chat and /logos Vue pages, files in public/, and mixed-case paths such as /errors/DF0036, because comark-content lowercases page paths. A new root lint:docs script runs comark-lint, and the CI lint step runs it.
  • The second commit wraps two objects in initiate.test.ts. main fails the antfu/reasonable-newline lint rule on them now, and that failure would stop the CI lint step before it reaches lint: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 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.

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 the comark-lint CLI 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-inspector render with no raw u-* or landing-hero tags in the HTML.
  • Vercel preview of this PR: /, /ecosystem, /guide/tutorial-server-data-inspector, and /errors/DF0036 return 200, with no raw u-* or landing-hero tags and with Vitesse colors in the code blocks. When I checked, https://devfra.me/ on main returned 500 FUNCTION_INVOCATION_FAILED, so the landing page has no "before" image.

Visual changes

Code blocks on /guide/tutorial-server-data-inspector look the same as on devfra.me (Vitesse light and dark). In nuxt 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.

- 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
Copilot AI balanced review requested due to automatic review settings November 2, 2026 17:16
@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
devframe Ready Ready Preview Nov 2, 2026 5:17pm UTC

@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

👁️‍🗨️ Review this pull request with grouped, summarized diffs at:
👉 https://pulls.review/gh/devframes/devframe/481?from=github-actions[bot]

raw result

💭 analyzed by vercel-ai-gateway/anthropic/claude-sonnet-5
🕰️ 2026-11-02 17:16 UTC
🔗 head 9e5f593
🤖 automated by pulls.review

{
  "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"
  }
}

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 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

@atinux
atinux merged commit 415a307 into main Nov 2, 2026
15 checks passed
@atinux
atinux deleted the docs/comark-docs-layer branch November 2, 2026 18:09

This branch was successfully deployed

1 active deployment
Preview — 9e5f5938 Deployed Nov 2, 2026 by vercel[bot]
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