Comprehensive documentation site for Wundr platform
npm install @wundr.io/docsComprehensive documentation site for the Wundr platform - the Intelligent CLI-Based Coding Agents Orchestrator.
- π 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
- Node.js 18+
- npm or pnpm
``bashInstall dependencies
npm install
$3
`bash
Development
npm start # Start dev server (all languages)
npm start -- --locale es # Start with specific localeBuild
npm run build # Build all languages
npm run serve # Serve built site locallyDocumentation Generation
npm run generate-api-docs # Generate API documentation
npm run generate-translations # Create translation infrastructure
npm run generate-playground # Generate interactive playgroundI18n Management
npm run i18n-maintenance report # Generate translation report
npm run i18n-maintenance validate # Validate translation files
npm run write-translations # Extract translatable stringsUtilities
npm run clear # Clear cache
npm run typecheck # Run TypeScript checks
`Architecture
$3
`
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
`$3
- 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
$3
- English (en): Default locale
- Spanish (es): EspaΓ±ol
- French (fr): FranΓ§ais
- German (de): Deutsch
$3
Uses
@easyops-cn/docusaurus-search-local for offline search:`typescript
{
hashed: true,
language: ['en', 'es', 'fr', 'de'],
indexDocs: true,
indexBlog: true,
indexPages: true,
highlightSearchTermsOnTargetPage: true,
searchResultLimits: 8,
}
`Translation Workflow
$3
1. Create English content first in
docs/
2. Generate translation files:
`bash
npm run generate-translations
`
3. Translate content in i18n/{locale}/docusaurus-plugin-content-docs/current/
4. Update sidebar translations in i18n/{locale}/docusaurus-plugin-content-docs/current.json$3
`bash
Check translation status
npm run i18n-maintenance reportValidate all translation files
npm run i18n-maintenance validateView detailed translation report
cat i18n/reports/maintenance-$(date +%Y-%m-%d).md
`$3
Current translation completeness:
- πΊπΈ English: 100% (source)
- πͺπΈ Spanish: ~60% (core content translated)
- π«π· French: ~60% (core content translated)
- π©πͺ German: ~60% (core content translated)
Development
$3
#### 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
$3
Custom CSS variables for consistent theming:
`css
:root {
--wundr-primary: #0066cc;
--wundr-secondary: #666;
--wundr-accent: #ff6b35;
}
`Deployment
$3
`bash
Production build
npm run buildTest production build locally
npm run serve
`$3
- Multi-language sitemap generation
- Proper hreflang tags
- Localized meta descriptions
- Open Graph tags per locale
$3
- Code splitting by language
- Optimized search indices
- Image optimization with
@docusaurus/plugin-ideal-image
- Lazy loading for non-critical contentAPI Documentation
Auto-generated from existing API routes:
`bash
Generate API documentation
npm run generate-api-docsOutput: api/ directory with OpenAPI specs and Markdown files
`Contributing
$3
1. Follow the existing structure and style
2. Use proper heading hierarchy (H1 -> H2 -> H3)
3. Include code examples where applicable
4. Add translations for new content
$3
1. Maintain consistency with existing translations
2. Use the translation glossary for technical terms
3. Test builds before submitting
4. Follow the i18n workflow
$3
1. Use TypeScript for all new components
2. Follow React best practices
3. Add proper JSDoc comments
4. Test responsive behavior
Troubleshooting
$3
`bash
Clear cache and rebuild
npm run clear && npm run buildCheck for missing files referenced in sidebars
npm run i18n-maintenance validate
`$3
- Verify search plugin configuration in
docusaurus.config.ts
- Rebuild search indices by clearing cache
- Check browser console for JavaScript errors$3
`bash
Generate translation report
npm run i18n-maintenance reportFix common issues
- Missing translation keys
- Invalid JSON syntax
- Broken internal links
``- Docusaurus Documentation
- I18n Workflow Guide
- API Documentation
- Component Library
MIT License - see the LICENSE file for details.
For documentation issues:
- GitHub Issues
- Discussion Forum
- Discord Server