@wundr.io/docs

v1.0.6

Published

21 days ago

Comprehensive documentation site for Wundr platform

Downloads

104

0High
0Medium
0Low

adaptic-dev

Wundr Documentation

Comprehensive documentation site for the Wundr platform - the Intelligent CLI-Based Coding Agents Orchestrator.

Features

🌐 Multi-language Support: Available in English, Spanish, French, and German
🔍 Advanced Search: Local search with analytics and cross-language support
📱 Mobile Responsive: Optimized for all device sizes
🎨 Modern UI: Built with Docusaurus 3.x and custom components
📊 Search Analytics: Track popular queries and user engagement
🔄 Translation Management: Automated i18n workflow and maintenance

Quick Start

Prerequisites

Node.js 18+
npm or pnpm

Installation

# Install dependencies
npm install

# Start development server
npm start

# Build for production
npm run build

Available Scripts

# Development
npm start                    # Start dev server (all languages)
npm start -- --locale es    # Start with specific locale

# Build
npm run build               # Build all languages
npm run serve              # Serve built site locally

# Documentation Generation
npm run generate-api-docs      # Generate API documentation
npm run generate-translations  # Create translation infrastructure
npm run generate-playground    # Generate interactive playground

# I18n Management
npm run i18n-maintenance report    # Generate translation report
npm run i18n-maintenance validate  # Validate translation files
npm run write-translations         # Extract translatable strings

# Utilities
npm run clear              # Clear cache
npm run typecheck         # Run TypeScript checks

Architecture

Structure

packages/@wundr/docs/
├── docs/                  # Main documentation content
├── blog/                  # Blog posts
├── api/                   # API documentation
├── guides/                # User guides
├── src/
│   ├── components/        # Custom React components
│   ├── utils/             # Utility functions
│   └── css/              # Custom styles
├── i18n/                  # Translations
│   ├── es/               # Spanish translations
│   ├── fr/               # French translations
│   ├── de/               # German translations
│   └── reports/          # Translation reports
├── scripts/              # Build and maintenance scripts
├── static/               # Static assets
└── sidebars*.ts          # Sidebar configurations

Key Components

SearchAnalytics: Tracks search metrics and popular queries
LanguageSwitcher: Enhanced language switching with visual indicators
TranslationGenerator: Automated translation infrastructure creation
I18nMaintenance: Translation status and quality management

Configuration

Supported Languages

English (en): Default locale
Spanish (es): Español
French (fr): Français
German (de): Deutsch

Search Configuration

Uses @easyops-cn/docusaurus-search-local for offline search:

{
  hashed: true,
  language: ['en', 'es', 'fr', 'de'],
  indexDocs: true,
  indexBlog: true,
  indexPages: true,
  highlightSearchTermsOnTargetPage: true,
  searchResultLimits: 8,
}

Translation Workflow

Adding New Content

Create English content first in docs/
Generate translation files:
```
npm run generate-translations
```
Translate content in i18n/{locale}/docusaurus-plugin-content-docs/current/
Update sidebar translations in i18n/{locale}/docusaurus-plugin-content-docs/current.json

Maintaining Translations

# Check translation status
npm run i18n-maintenance report

# Validate all translation files
npm run i18n-maintenance validate

# View detailed translation report
cat i18n/reports/maintenance-$(date +%Y-%m-%d).md

Translation Status

Current translation completeness:

🇺🇸 English: 100% (source)
🇪🇸 Spanish: ~60% (core content translated)
🇫🇷 French: ~60% (core content translated)
🇩🇪 German: ~60% (core content translated)

Development

Custom Components

SearchAnalytics

Provides search metrics and analytics:

Popular queries tracking
No-result queries identification
Language-specific search volume
Real-time analytics display

LanguageSwitcher

Enhanced language switching:

Visual language indicators
Proper URL transformation
Mobile-responsive design
Current language highlighting

Theme Customization

Custom CSS variables for consistent theming:

:root {
  --wundr-primary: #0066cc;
  --wundr-secondary: #666;
  --wundr-accent: #ff6b35;
}

Deployment

Build Process

# Production build
npm run build

# Test production build locally
npm run serve

SEO Optimization

Multi-language sitemap generation
Proper hreflang tags
Localized meta descriptions
Open Graph tags per locale

Performance

Code splitting by language
Optimized search indices
Image optimization with @docusaurus/plugin-ideal-image
Lazy loading for non-critical content

API Documentation

Auto-generated from existing API routes:

# Generate API documentation
npm run generate-api-docs

# Output: api/ directory with OpenAPI specs and Markdown files

Contributing

Documentation

Follow the existing structure and style
Use proper heading hierarchy (H1 -> H2 -> H3)
Include code examples where applicable
Add translations for new content

Translations

Maintain consistency with existing translations
Use the translation glossary for technical terms
Test builds before submitting
Follow the i18n workflow

Code

Use TypeScript for all new components
Follow React best practices
Add proper JSDoc comments
Test responsive behavior

Troubleshooting

Build Issues

# Clear cache and rebuild
npm run clear && npm run build

# Check for missing files referenced in sidebars
npm run i18n-maintenance validate

Search Problems

Verify search plugin configuration in docusaurus.config.ts
Rebuild search indices by clearing cache
Check browser console for JavaScript errors

Translation Issues

# Generate translation report
npm run i18n-maintenance report

# Fix common issues
# - Missing translation keys
# - Invalid JSON syntax
# - Broken internal links