CLclaudux

Appearance

Features Overview ​

Claudux combines AI-powered code analysis with modern documentation tooling to solve the documentation maintenance problem.

Core Features ​

🔄 Automatic Updates ​

Problem: Documentation becomes stale the moment you ship new code.

Solution: Claudux analyzes your actual source code on every run, detecting:

  • New functions and APIs
  • Changed behavior and patterns
  • Deprecated or removed features
  • Updated configuration options
bash
claudux update  # Always generates current documentation

🧠 Code Understanding ​

Problem: Generic documentation templates don't capture your project's uniqueness.

Solution: Claude AI understands your codebase structure and patterns:

  • Analyzes import/export relationships
  • Detects architectural patterns (MVC, microservices, etc.)
  • Understands framework conventions (React hooks, Express middleware)
  • Preserves domain-specific terminology

⚡ One-Command Generation ​

Problem: Documentation toolchains are complex and time-consuming.

Solution: Single command generates complete sites:

bash
claudux update  # Generates VitePress site with navigation, search, mobile support

Includes:

  • Responsive navigation structure
  • Full-text search
  • Mobile-friendly design
  • Auto-generated breadcrumbs
  • Dark/light theme toggle

🔒 Privacy First ​

Problem: Cloud-based tools require uploading your source code.

Solution: Everything runs locally:

  • Code never leaves your machine
  • Uses locally installed Claude CLI
  • Processes files in your environment
  • No external API calls for source analysis

🍰 Zero Configuration ​

Problem: Documentation tools require extensive setup and maintenance.

Solution: Intelligent project detection and defaults:

bash
cd any-project
claudux update  # Just works

Auto-detects:

  • Project type (React, Python, Go, etc.)
  • Entry points and main modules
  • Testing frameworks and build tools
  • Existing documentation patterns

Advanced Features ​

Prevents broken documentation with built-in validation:

bash
claudux update  # Includes automatic link checking

Validates:

  • Internal page references
  • Anchor links within pages
  • Asset and image references
  • External URL accessibility

Auto-fix capability:

bash
claudux update -m "Fix broken links and create missing pages"

🛡️ Content Protection ​

Preserves sensitive or manually curated content:

markdown
<!-- skip -->
This section won't be modified by claudux
<!-- /skip -->

Automatically protects:

  • notes/ and private/ directories
  • Environment files (*.env, *.key)
  • Configuration secrets

🎯 Focused Updates ​

Target specific documentation areas:

bash
claudux update -m "Update API documentation only"
claudux update --with "Add examples for the new authentication flow"

📱 Project-Specific Optimization ​

Adapts documentation structure to your project type:

CLI tools: Command reference, installation, examples
Libraries: API docs, integration guides, usage patterns
Web apps: Features, deployment, configuration
Mobile apps: Setup, architecture, app store guidelines

Quality Assurance ​

Accuracy Guarantees ​

  • Code examples: Extracted from actual source files
  • API documentation: Based on current function signatures
  • Installation steps: Derived from package.json, requirements.txt, etc.
  • No placeholders: All content references real project elements

Consistency Features ​

  • Unified navigation: Sidebar appears on all pages
  • Cross-references: Automatic linking between related concepts
  • Terminology: Consistent use of project-specific terms
  • Styling: Follows your project's established patterns

Next Steps ​

Explore specific features in detail:

Generated with claudux

Copyright © 2025 claudux