Files
docs_tfgrid_economics/README.md
mik-tf 65fbdb836b
Some checks failed
Deploy to GitHub Pages / Deploy to GitHub Pages (push) Has been cancelled
Initial commit: TFGrid Economics documentation site
- Based on working minting_plan repository
- Configured for threefold.info/economics deployment
- Added ops documentation for server deployment
- Updated baseUrl and URL configuration
2025-10-10 21:38:17 -04:00

3.7 KiB

TFT Minting Transition Plan

Community e-book for the ThreeFold Token (TFT) minting transition plan.

Live Site: https://plan.threefold.pro

Overview

This repository contains the documentation for the TFT Minting Transition Plan, a comprehensive proposal for transitioning ThreeFold's token economics to a more sustainable and community-oriented model. The plan introduces:

  • Dual Token System: TFT (tradable) and Cloud Credits (stable utility)
  • Position-Based Liquidity Pools: Fair, time-weighted rewards
  • Dutch Auction Exit Mechanism: Controlled, sustainable liquidity
  • Yin-Yang Currency Philosophy: Balancing market and community

Quick Start

Prerequisites

  • Node.js 18+
  • npm

Installation

# Clone the repository
git clone https://github.com/mik-tf/minting_plan.git
cd minting_plan

# Install dependencies
npm install

# Start development server
npm start

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

Build

# Create production build
npm run build

# Serve production build locally
npm run serve

Project Structure

minting_plan/
├── docs/                       # Documentation content
│   ├── intro.md                # Homepage/Introduction
│   ├── core-concepts/          # Core finance concepts
│   ├── appendix/               # Meeting notes & resources
│   └── ops/                    # Operations documentation
├── static/                     # Static assets
│   ├── img/                    # Images
│   └── CNAME                   # Custom domain config
├── src/                        # Custom components & styles
│   └── css/
│       └── custom.css          # Custom styling
├── docusaurus.config.js        # Docusaurus configuration
├── sidebars.js                 # Sidebar structure
└── package.json                # Dependencies

Contributing

Making Changes

  1. Pull latest changes:

    git pull origin main
    
  2. Make your edits in docs/

  3. Test locally:

    npm start
    
  4. Test production build:

    npm run build
    
  5. Commit and push:

    git add .
    git commit -m "Description of changes"
    git push origin main
    
  6. GitHub Actions automatically deploys to https://plan.threefold.pro

Content Guidelines

  • Write clear, concise documentation
  • Use proper Markdown formatting
  • Add alt text to images
  • Test builds before pushing
  • See Content Updates Guide for details

Deployment

This site automatically deploys to GitHub Pages via GitHub Actions when you push to the main branch.

  • Domain: plan.threefold.pro
  • Branch: gh-pages (auto-generated)
  • Build Time: ~2-3 minutes

See Deployment Guide for full details.

Community Feedback

We welcome community feedback on this plan through:

Documentation

Full documentation available at:

Technology Stack

License

Copyright © 2025 ThreeFold