Rustelo/info/docs-info-path-are-needed.md
Jesús Pérex 2f0f807331 feat: add dark mode functionality and improve navigation system
- Add complete dark mode system with theme context and toggle
- Implement dark mode toggle component in navigation menu
- Add client-side routing with SSR-safe signal handling
- Fix language selector styling for better dark mode compatibility
- Add documentation system with mdBook integration
- Improve navigation menu with proper external/internal link handling
- Add comprehensive project documentation and configuration
- Enhance theme system with localStorage persistence
- Fix arena panic issues during server-side rendering
- Add proper TypeScript configuration and build optimizations

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-07-11 20:53:20 +01:00

1.9 KiB

Answer: No, you don't need the info and docs directories to view the documentation!

Here's what I found:

📚 Core Documentation Structure

The documentation system has three levels:

  1. 📁 book/ directory - Required - Main documentation source

    • Contains the complete mdBook documentation structure
    • Has 80 pages of comprehensive guides
    • Includes all essential content for using Rustelo
  2. 📁 docs/ directory - Optional - Supplementary documentation

    • Contains additional technical documentation
    • Used for enhanced content when building with --sync
  3. 📁 info/ directory - Optional - Development notes

    • Contains development notes and implementation details
    • Used for enhanced content when building with --sync

What Works Without info and docs

Basic documentation build:

just docs-build
  • Builds successfully (80 pages, 3.2M)
  • Complete user documentation
  • All essential guides and tutorials
  • Feature documentation
  • API reference
  • Getting started guides

With sync (uses info and docs):

just docs-build-sync
  • Builds successfully (80 pages, 3.7M)
  • Includes additional technical details
  • Enhanced feature documentation
  • Development implementation notes

🎯 Recommendation

For normal use: Just keep the book/ directory - it contains everything users need to work with Rustelo.

For development: Keep all three directories if you want the most comprehensive documentation with all implementation details.

The book/ directory alone provides:

  • Complete getting started guide
  • All feature documentation
  • Configuration guides
  • Deployment instructions
  • API reference
  • Security guides
  • Troubleshooting
  • And much more!

So you can safely remove or ignore the info and docs directories if you want a lighter template, and the documentation will still work perfectly! 🚀