Skip to content

CLAUDE.md

Latest commit

 

History

History
64 lines (42 loc) · 2.17 KB

CLAUDE.md

File metadata and controls

64 lines (42 loc) · 2.17 KB
Raw

CLAUDE.md

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

Project Overview

Multi-instance Docusaurus 3 documentation portal for the TestBench Ecosystem by imbus AG. Hosts documentation for multiple tools, each with independent versioning.

Development Commands

All commands run from the docusaurus/ directory:

cd docusaurus

npm start          # Start dev server (localhost:3000)
npm run build      # Build for development
npm run build:prod # Build for production
npm run serve      # Serve the built output locally
npm run clear      # Clear Docusaurus cache
npm run typecheck  # TypeScript type checking

Architecture

Multi-Instance Tool Discovery

Tools are auto-discovered by scanning for sidebars_*.ts files in docusaurus/. No manual plugin registration is needed.

To add a new tool named <tool-id>:

  1. Create docusaurus/<tool-id>/ with at least intro.md
  2. Create docusaurus/sidebars_<tool-id>.ts

The tool will automatically appear in the Ecosystem navbar dropdown and get its own docs route at /<tool-id>/.

Directory Layout

  • docusaurus/docs/ — Global ecosystem docs (route: /docs/)
  • docusaurus/<tool-id>/ — Per-tool docs (route: /<tool-id>/)
  • docusaurus/src/ — React components, custom pages, CSS
  • docusaurus/static/ — Static assets (images, fonts)

Versioning

Each tool maintains independent versions:

  • docusaurus/<tool-id>_versions.json
  • docusaurus/<tool-id>_versioned_docs/
  • docusaurus/<tool-id>_versioned_sidebars/

Key Config Files

  • docusaurus/docusaurus.config.ts — Main site config, plugin registration, navbar/footer
  • docusaurus/sidebars.ts — Global docs sidebar
  • docusaurus/sidebars_<tool-id>.ts — Per-tool sidebars (all autogenerated)

Custom Components

  • src/components/custom-toolAndVersion/ — Navbar component for tool routing and version switching
  • Syntax highlighting includes: PowerShell, C#, Java, Bash, JSON, YAML, TOML, INI, Properties

CI/CD

  • PR previews: Deployed to https://<repo>-pr-<number>.surge.sh via GitHub Actions
  • Production: Released to GitHub Pages on GitHub release publication