ask-user-help-docs

Maintains the Fumadocs help site mounted at /docs in qwksearch-web on Cloudflare Workers.

74|11|Updated Jul 4, 2024
One-click install
npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill ask-user-help-docs-opensourceagi
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ask-user-help-docs
Source: https://github.com/OpenSourceAGI/qwksearch-research-agent/tree/main/skills/ask-user-help-docs
Command: npx skills add https://github.com/OpenSourceAGI/qwksearch-research-agent --skill ask-user-help-docs-opensourceagi

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? The user-help-docs package renders the /docs help site inside qwksearch-web, but it cannot use fumadocs-mdx's standard codegen pipeline because the host deploys to Cloudflare Workers, where filesystem scans and runtime code generation are unavailable. This Skill explains the import.meta.glob architecture, the build-time MDX plugin, and the host-side wiring needed to keep /docs working. ## Core Features & Use Cases - Content management: Add or reorder help pages by creating MDX files in content/docs and registering slugs in meta.json, which controls ordering. - Build integration: Register helpDocsMdxPlugin() in the host's Vite and Vitest configs so MDX compiles at bundle time instead of request time. - Styling and search wiring: Configure the host's Tailwind entry with fumadocs-ui imports and @source directives, and mount searchServer at the route named by docsConfig.searchApi. - Use Case: When /docs renders as one unstyled column with no sidebar, diagnose the missing @source for fumadocs-ui/dist in the host's Tailwind entry rather than changing content. ## Quick Start Add a new help page to the /docs site and make sure it appears in the correct position in the navigation.

Frequently Asked Questions about ask-user-help-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new page to a Fumadocs documentation site?

Create an MDX file with title and description frontmatter in content/docs, then add its slug to meta.json. Ordering comes from meta.json, not the filesystem, so a page missing from meta.json will 404.

Why does my Fumadocs site render unstyled with no sidebar?

The host's Tailwind entry is not scanning fumadocs-ui/dist. The preset's @source inline lists are dropped by Vite's CSS import handling, so you must add explicit @source directives for fumadocs-ui/dist and the package's own src directory.

Can fumadocs-mdx run on Cloudflare Workers?

Not with its standard codegen or runtime compilation. Workers have no filesystem to scan and forbid code generation from strings, so content must be inlined with import.meta.glob and MDX compiled at bundle time via a Vite plugin.

Why do /docs routes 500 only in production on Workers?

Something compiles MDX at request time using new Function, which workerd rejects with EvalError: Code generation from strings disallowed. Move compilation to the bundler with helpDocsMdxPlugin() registered in the Vite config.

Why does Fumadocs search return no results?

Search structured data is computed by structure() over the raw body at index time, so a page whose body failed to compile indexes empty. Also verify the search route matches docsConfig.searchApi.

What does the 'No compiled module for' error mean at startup?

The host's Vite or Vitest config is missing helpDocsMdxPlugin(). The plugin must be registered in both configs so the eager import.meta.glob of MDX files resolves to compiled modules.