Skip to content

UseJDL Docs

UseJDL Docs is a lightweight VitePress documentation site with two clearly separated areas:

  • Public docs for content that can be published openly.
  • Internal docs for team-only material that will later be protected with Cloudflare Access or Workers.

Choose The Right Area

Public

Use the public area for onboarding, product usage, external integration notes, and any content that is safe to expose on the internet.

Open public docs

Internal

Use the internal area for architecture notes, delivery workflow, maintenance rules, and operational guidance that should stay inside the team.

Open internal docs

Working Rules

  • Write new pages in Markdown and keep them task-focused.
  • Decide public vs internal before creating a page.
  • Keep sensitive implementation details out of public.
  • Treat internal as protected content even before access control is enabled.

Current Scope

This first version is intentionally small:

  • A VitePress site with TypeScript config
  • A stable navigation and sidebar
  • A public getting-started page
  • Internal pages for architecture and AI-assisted documentation workflow

That keeps the repo easy for humans and Codex to maintain over time.