Skip to content

CLAUDE.md

Latest commit

 

History

History
66 lines (45 loc) · 2.49 KB

CLAUDE.md

File metadata and controls

66 lines (45 loc) · 2.49 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project overview

This is the DEDZED documentation site built on Mintlify. Pages are MDX files with YAML frontmatter. Site configuration lives in docs.json.

Commands

# Install the Mintlify CLI (requires Node.js >= 19)
npm i -g mint

# Local preview at http://localhost:3000
mint dev

# Custom port
mint dev --port 3333

# Check for broken links
mint broken-links

# Update CLI to latest version
npm mint update

Architecture

  • docs.json — site configuration: navigation, theme, colors, logos, navbar, footer
  • index.mdx — landing page with service links and navigation cards
  • getting-started/ — onboarding guides: prerequisites, self-registration, cluster deployment, provisioning info
  • kasm-workspaces/ — Kasm VDI documentation: working within Kasm, cluster connection, software installation
  • knowledge-base/ — reference material: what is DEDZED, ephemeral environments FAQ, k9s cheat sheet, Python dev, DEDZED AI
  • support/ — contact info, terms, privacy policy
  • images/, logo/ — static assets
  • .mintignore — files excluded from Mintlify builds (drafts, *.draft.mdx)

Important terminology

  • DEDZED / D3DZ3D — the platform name (proper noun, NOT an acronym — never expand it)
  • DEDZED Command Dashboard — the main portal UI (do NOT refer to this as "Backstage")
  • Ping Identity — the authentication provider (do NOT refer to this as "EntraID" or "Microsoft EntraID")
  • Kasm — the Virtual Desktop Infrastructure (VDI) browser-based desktop
  • Big Bang — the DevSecOps Kubernetes platform deployed on ephemeral clusters

Content conventions

  • All pages must register in docs.json under navigation.tabs[].groups[].pages to appear in the site
  • Use active voice and second person ("you")
  • Sentence case for headings
  • Bold for UI elements: Click Settings
  • Code formatting for file names, commands, paths, and code references
  • One idea per sentence

Agents

Custom Claude Code agents for this project are defined in .claude/agents/. See AGENTS.md for the full catalog and usage instructions.

Available agents: docs-writer, docs-reviewer, site-architect, content-auditor, terminology-guard.

These can be dispatched individually via the Task tool or coordinated as a team for site-wide improvement passes.

Deployment

Changes pushed to the default branch auto-deploy via the Mintlify GitHub app.