tfgrid/docs_tfgrid_get_started

Fork 0

Files

mik-tf 6ac21c9550 fix: update docs without banner and with proper telegram links

2025-10-16 08:52:03 -04:00

4.5 KiB

Raw Blame History

TFGrid Get Started

Your gateway to ThreeFold - learn how to farm, connect, and deploy on the decentralized internet.

Live Site: https://threefold.info/getstarted

Overview

This repository contains the getting started documentation for ThreeFold, designed to help newcomers:

Become a Farmer - Deploy nodes and earn rewards
Use Mycelium Network - Connect devices securely with IPv6 overlay networking
Deploy on Mycelium Cloud - Run Kubernetes clusters on the ThreeFold Grid

Quick Start

Prerequisites

Node.js 18+
pnpm (or npm)

Installation

# Clone the repository
git clone https://git.ourworld.tf/tfgrid/docs_tfgrid_get_started
cd docs_tfgrid_get_started

# Install dependencies
pnpm install

# Start development server
pnpm start

The site will open at http://localhost:3000.

Build

# Create production build
pnpm run build

# Serve production build locally
pnpm run serve

Project Structure

docs_tfgrid_get_started/
├── docs/                       # Documentation content
│   ├── intro.md                # Homepage/Introduction
│   ├── farming/                # Farming guides
│   │   ├── overview.md
│   │   ├── buy-node.md
│   │   └── setup.md
│   ├── mycelium-network/       # Mycelium Network guides
│   │   ├── overview.md
│   │   ├── install.md
│   │   └── quick-start.md
│   └── mycelium-cloud/         # Mycelium Cloud guides
│       ├── overview.md
│       ├── getting-started.md
│       └── tutorial.md
├── static/                     # Static assets
│   ├── img/                    # Images and logos
│   ├── CNAME                   # Custom domain config
│   └── _redirects              # Redirect rules
├── src/                        # Custom components & styles
│   └── css/
│       └── custom.css          # Custom styling
├── docusaurus.config.js        # Docusaurus configuration
├── sidebars.js                 # Sidebar structure
├── package.json                # Dependencies
├── build.sh                    # Production build script
└── develop.sh                  # Development script

Contributing

Making Changes

Pull latest changes:
```
git pull origin main
```
Make your edits in docs/
Test locally:
```
pnpm start
```
Test production build:
```
pnpm run build
```

Commit and push:

git add .
git commit -m "Description of changes"
git push origin main

Content Guidelines

Keep it simple - Target audience is new to ThreeFold
Be concise - No fluff, straight to the point
Use examples - Practical code snippets and commands
Clear structure - Logical flow from overview to hands-on
Test builds - Always verify builds succeed before pushing

Documentation Sections

Farming

Guides for becoming a ThreeFold farmer:

What is farming and why do it
How to buy or build a node
Setting up and connecting to the grid

Mycelium Network

Guides for using Mycelium networking:

What is Mycelium and its benefits
Installation across platforms
Quick start and connectivity

Mycelium Cloud

Guides for deploying on the grid:

What is Mycelium Cloud
Getting started with clusters
Deployment tutorials and examples

Development

Local Development

# Start development server
./develop.sh
# OR
pnpm start

This command starts a local development server and opens a browser window. Most changes are reflected live without restarting the server.

Build & Deploy

# Build for production
./build.sh
# OR
pnpm run build

The build script also handles deployment to the production server.

Technology Stack

Docusaurus 3 - Documentation framework
React 18 - UI library
MDX - Markdown with JSX support

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

4.5 KiB Raw Blame History