# 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

```bash
# 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

```bash
# 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:
   ```bash
   git pull origin main
   ```

2. Make your edits in `docs/`

3. Test locally:
   ```bash
   npm start
   ```

4. Test production build:
   ```bash
   npm run build
   ```

5. Commit and push:
   ```bash
   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](./docs/ops/content-updates.md) 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](./docs/ops/deployment.md) for full details.

## Community Feedback

We welcome community feedback on this plan through:

- **Telegram**: https://t.me/threefoldfarmers
- **Forum**: https://forum.threefold.io
- **Community Call**: https://bit.ly/tfcommunitycall

## Documentation

Full documentation available at:
- [Local Development](./docs/ops/local-development.md)
- [Deployment](./docs/ops/deployment.md)
- [Content Updates](./docs/ops/content-updates.md)

## Technology Stack

- [Docusaurus 3](https://docusaurus.io/) - Documentation framework
- [React 18](https://react.dev/) - UI library
- [GitHub Pages](https://pages.github.com/) - Hosting
- [GitHub Actions](https://github.com/features/actions) - CI/CD

## License

Copyright © 2025 ThreeFold

## Links

- [ThreeFold](https://threefold.io)
- [ThreeFold Forum](https://forum.threefold.io)
- [Telegram Community](https://t.me/threefoldfarmers)