Files
docs_tfgrid_economics/README.md
mik-tf f9a5d8086a
Some checks are pending
Deploy to GitHub Pages / Deploy to GitHub Pages (push) Waiting to run
docs: Update README with new repository URL and remove deployment info
2025-10-16 07:47:45 -04:00

133 lines
3.2 KiB
Markdown

# TFT Minting Transition Plan
Community e-book for the ThreeFold Token (TFT) minting transition plan.
**Live Site**: https://threefold.info/economics
## 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://git.ourworld.tf/tfgrid/docs_tfgrid_economics
cd docs_tfgrid_economics
# Install dependencies
pnpm install
# Start development server
pnpm start
```
The site will open at `http://localhost:3000`.
### Build
```bash
# Create production build
pnpm run build
# Serve production build locally
pnpm 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
```
### 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
## 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
## License
Copyright © 2025 ThreeFold
## Links
- [ThreeFold](https://threefold.io)
- [ThreeFold Forum](https://forum.threefold.io)
- [Telegram Community](https://t.me/threefoldfarmers)