Skip to content

ultravioletrs/cube-docs

Repository files navigation

Cube AI Documentation

Documentation site for Cube AI, served at:

Built with Next.js and Fumadocs, deployed to Cloudflare Workers as a static export nested under /docs/cube-ai/.

Development

pnpm install
pnpm dev

Validation

pnpm run lint         # Biome check
pnpm run lint:fix     # Biome check + auto-fix
pnpm run lint:md      # Markdown lint
pnpm run types:check  # TypeScript type check

Build & Deploy

pnpm run build    # next build + nest-static-export
pnpm run start    # serve ./out locally
pnpm run deploy   # build + wrangler deploy
pnpm run upload   # build + wrangler versions upload

Project Structure

app/
  layout.tsx          # Root DocsLayout
  [[...slug]]/        # Catch-all docs page
  sitemap.ts
  global.css
components/
  BrandLogo.tsx
content/docs/         # MDX source files
lib/
  base-path.ts        # basePath helpers (assetPath, toSiteUrl, …)
  layout.shared.tsx   # Shared nav options
  metadata.ts         # createMetadata helper
  source.ts           # Fumadocs source loader
public/
  img/                # Images referenced by docs
  _headers            # Cloudflare cache headers
  _redirects          # Cloudflare redirects
  robots.txt
scripts/
  nest-static-export.mjs  # Post-build: nest out/ under docs/cube-ai/
wrangler.jsonc        # Cloudflare Workers config
biome.json            # Linter / formatter (Biome)

Tooling

  • Linter / Formatter: Biome
  • Deployment: Cloudflare Workers (static assets via wrangler deploy)
  • CI: GitHub Actions — lint → type check → build

About

Documentation for Cube AI

Resources

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors