ThreeFold Documentation Project

Comprehensive documentation for the ThreeFold ecosystem, including technical specifications, business documentation, product guides, and developer resources.

🌟 Overview

This repository contains the complete ThreeFold documentation ecosystem, built with Docusaurus and powered by Hero for advanced configuration management.

📚 Documentation Sections

• Main Grid Documentation - Core ThreeFold Grid documentation
• Business Documentation - Business model, tokenomics, and strategy
• Technical Documentation - Technical specifications and architecture
• Product Documentation - ThreeFold products and solutions
• AI Box Documentation - Personal AI powerhouse documentation
• Mycelium Net - End-to-end encrypted IPv6 overlay network
• Specifications - Detailed technical specifications
• Vendor Documentation - Node vendor guidelines and requirements
• New Internet Vision - Vision for Web4 and decentralized internet
• Hero Documentation - Hero tool documentation

🚀 Quick Start

Prerequisites

• Hero - Documentation generation tool
• Node.js (v18+) or Bun - JavaScript runtime
• Git - Version control

Installation

1. Clone the repository:

   git clone https://git.threefold.info/tfgrid/docs_tfgrid4.git
   cd docs_tfgrid4
   

2. Generate and start documentation:

   # Generate specific section
   cd ebooks/tfgrid_main
   hero docs -d
   
   # Start development server
   cd /Users/<username>/hero/var/docusaurus
   npm start
   

   The documentation will be available at http://localhost:3000

🧪 Development

Validate All Ebooks

To check all ebooks for build errors:

./scripts/check_ebooks.sh

This script will:

• Build each ebook in the ebooks/ directory
• Display build output in real-time
• Report which ebooks succeeded or failed
• Show detailed error messages for failed builds
• Exit with code 1 if any ebook fails (useful for CI/CD)

⚙️ Configuration

The project supports two configuration methods:

HeroScript Configuration (Recommended)

HeroScript provides a unified, powerful configuration system with template support.

Basic site configuration example:

# Basic Site Configuration
!!site.config
    name:"my-docs"
    title:"My Documentation"
    tagline:"Comprehensive documentation"
    url:"https://threefold.info"
    url_home:"docs/"
    base_url:"/my-docs/"
    favicon:"img/favicon.png"
    copyright:"© 2024 ThreeFold"
    build_dest:"root@51.195.61.5:/root/hero/www/info/my-docs"

# Mermaid Diagrams Support
!!site.plugin
    name:"@docusaurus/theme-mermaid"
    options:{}

!!site.markdown
    mermaid:true

JSON Configuration (Alternative)

Alternative method using separate JSON files for each configuration aspect.

Example main.json:

{
  "title": "My Documentation",
  "tagline": "Comprehensive documentation",
  "favicon": "img/favicon.png",
  "url": "https://threefold.info",
  "baseUrl": "/my-docs/",
  "buildDest": ["root@51.195.61.5:/root/hero/www/info/my-docs"],
  "copyright": "© 2024 ThreeFold",
  "name": "my-docs"
}