docs: migrate the site from VitePress to Nuxt with the comark-docs layer - #274
Merged
Conversation
❌ Deploy Preview for devfra failed.
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Deployment failed for project devframe with the following error: Learn More: https://vercel.com/docs/concepts/projects/project-configuration |
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.
Migrates the docs site to the same stack as comark's docs: Nuxt 4 extending the
comark-docslayer (comark-content + Nuxt UI v4 + Tailwind 4), targeting Vercel.What changed
docs/is now a Nuxt app —nuxt.config.tsextendscomark-docs,app/app.config.tscarries branding/nav/footer/OG/llms config. VitePress (.vitepress/,vite.config.ts, mermaid/group-icons plugins) is removed.docs/content/in the layer's numbered-directory convention (1.guide/2.rpc.md, …) with a.navigation.ymlper section, preserving the previous sidebar order and all existing URLs (/guide/rpc,/errors/DF0033, …). Every page's H1 became frontmattertitleand its lead paragraphdescription.::: code-group→ MDC::code-group, orphanedtwoslashfence meta dropped (was never wired up),<figure class="screenshot">blocks → markdown images with captions, relative links rewritten to absolute (the layer's extensionless routes resolve them differently than VitePress's directory URLs). GitHub-style callouts and mermaid fences are supported natively by the layer.::u-page-hero/::landing-features/::landing-ctacomponents, same hero copy and feature set as before./guide/→/guide).netlify.tomlremoved;docs/vercel.jsonadded (content-only pushes skip redeploys — the layer revalidates via ISR). The layer serves production content from GitHub at request time, so the Vercel project wants aGITHUB_TOKENto avoid anonymous rate limits.docscatalog now holdscomark-docs(github spec); knip override and typecheck-coverage exception updated; staledocs/guide/*.mdpath references in code comments and AGENTS.md updated to the new layout.Decisions to be aware of
blockExoticSubdeps: false(pnpm 11 default istrue): the layer pinscomark/comark-content/@comark/nuxtto pkg.pr.new snapshot URLs, which pnpm classifies as exotic subdeps; the setting has no per-package allowlist.trustPolicyExcludepins for@vercel/functions@3.9.3,@vercel/oidc@3.8.4,@vercel/cli-config@0.2.3,@vercel/cli-exec@1.0.1— recent Vercel-official releases without trusted-publisher evidence yet.https://devframe.devinnuxt.config.ts— adjust if the canonical domain differs.content/, but production assumes Vercel (ISR, runtime cache).devframeSidebar()/devframeNav()exports from the old VitePress config (unused in-repo) are gone; the layer derives navigation from the content tree.Verified:
pnpm lint && pnpm knip && pnpm test && pnpm typecheck && pnpm buildall pass;nuxt devrenders landing, guide (mermaid), adapters (code-group), plugins (screenshots), and error pages;nuxt buildcompletes.This PR was created with the help of an agent.