|
| 1 | +# Bittensor Documentation Resources |
| 2 | + |
| 3 | +## Official Documentation |
| 4 | +The primary sources for Bittensor documentation and learning resources. |
| 5 | +- Main Documentation: https://docs.bittensor.com - Comprehensive technical documentation covering all aspects of Bittensor |
| 6 | +- Learn Bittensor (More Accessible): https://learnbittensor.org - User-friendly explanations and tutorials for beginners |
| 7 | + |
| 8 | +## Core Concepts |
| 9 | +### Introduction |
| 10 | +- Introduction to Bittensor: https://docs.bittensor.com/learn/introduction |
| 11 | +- Learn Bittensor Introduction: https://learnbittensor.org/explore/article/introduction-to-bittensor |
| 12 | + |
| 13 | +### Subnets |
| 14 | +- Understanding Subnets: https://docs.bittensor.com/subnets/understanding-subnets |
| 15 | +- Creating Subnets: https://docs.bittensor.com/subnets/create-a-subnet |
| 16 | +- Subnet Management: |
| 17 | + - Subnet Creators Guide: https://docs.bittensor.com/subnets/subnet-creators-btcli-guide |
| 18 | + - Subnet Hyperparameters: https://docs.bittensor.com/subnets/subnet-hyperparameters |
| 19 | + - Working with Subnets: https://docs.bittensor.com/subnets/working-with-subnets |
| 20 | + - Walkthrough of example subnet: https://docs.bittensor.com/subnets/walkthrough-prompting |
| 21 | + |
| 22 | +### Consensus and Emissions |
| 23 | +The mechanisms that power Bittensor's incentive system and reward distribution. |
| 24 | +- Yuma Consensus: https://docs.bittensor.com/yuma-consensus - Technical details of Bittensor's consensus mechanism |
| 25 | +- Emissions: https://docs.bittensor.com/emissions - How TAO and alpha tokens are distributed in the network |
| 26 | + |
| 27 | +## Network Participants |
| 28 | +### Miners |
| 29 | +Participants who provide AI services to the network. |
| 30 | +- Miner Documentation: https://docs.bittensor.com/miners/ - Complete guide to mining on Bittensor |
| 31 | +- Miner Guide: https://docs.bittensor.com/miners/miners-btcli-guide - Command-line interface guide for miners |
| 32 | +- Learn Bittensor Miner Concept: https://learnbittensor.org/explore/concept/miner - Simplified explanation of mining |
| 33 | + |
| 34 | +### Validators |
| 35 | +Network participants who verify and rank miner performance. |
| 36 | +- Validator Documentation: https://docs.bittensor.com/validators/ - Comprehensive validator guide |
| 37 | +- Validator Guide: https://docs.bittensor.com/validators/validators-btcli-guide - CLI operations for validators |
| 38 | +- Child Hotkeys: https://docs.bittensor.com/validators/subnets/child-hotkeys - Managing multiple validator instances |
| 39 | +- Learn Bittensor Validator Concept: https://learnbittensor.org/explore/concept/validator - Beginner's guide to validation |
| 40 | + |
| 41 | +### Staking and Delegation |
| 42 | +- Staking/Delegation Overview: https://docs.bittensor.com/staking-and-delegation/delegation |
| 43 | +- Staking Guides: |
| 44 | + - BTCLI Guide: https://docs.bittensor.com/staking-and-delegation/stakers-btcli-guide |
| 45 | + - Managing Stake with BTCLI: https://docs.bittensor.com/staking-and-delegation/managing-stake-btcli |
| 46 | + - Managing Stake with SDK: https://docs.bittensor.com/staking-and-delegation/managing-stake-sdk |
| 47 | + - Polkadot.js Guide: https://docs.bittensor.com/staking-and-delegation/staking-polkadot-js |
| 48 | + - Ledger Hardware Wallet: https://docs.bittensor.com/staking-and-delegation/using-ledger-hw-wallet |
| 49 | + |
| 50 | +## Development Tools |
| 51 | +Essential tools for building and interacting with Bittensor. |
| 52 | + |
| 53 | +### BTCLI (Command Line Interface) |
| 54 | +The primary command-line tool for Bittensor operations. |
| 55 | +- Overview: https://docs.bittensor.com/btcli/overview - Introduction to BTCLI |
| 56 | +- Installation: https://docs.bittensor.com/getting-started/install-btcli - Setting up BTCLI |
| 57 | +- Playground: https://docs.bittensor.com/btcli/btcli-playground - Interactive BTCLI learning environment |
| 58 | +- Permissions: https://docs.bittensor.com/btcli-permissions - Understanding BTCLI access levels |
| 59 | + |
| 60 | +### Bittensor Python SDK |
| 61 | +- Installation: https://docs.bittensor.com/getting-started/installation |
| 62 | +- Wallet SDK Installation: https://docs.bittensor.com/getting-started/install-wallet-sdk |
| 63 | +- SDK Documentation: |
| 64 | + - Async Subtensor: https://docs.bittensor.com/python-api/autoapi/bittensor/core/async_subtensor/index.html |
| 65 | + - Subtensor: https://docs.bittensor.com/python-api/autoapi/bittensor/core/subtensor/index.html |
| 66 | +- Migration Guide: https://docs.bittensor.com/migration_guide |
| 67 | +- Subtensor Connections: https://docs.bittensor.com/sdk/managing-subtensor-connections |
| 68 | + |
| 69 | +## Security |
| 70 | +### Wallets and Keys |
| 71 | +- Wallet Basics: https://docs.bittensor.com/getting-started/wallets |
| 72 | +- Seed Phrase Security: https://docs.bittensor.com/keys/handle-seed-phrase |
| 73 | +- Coldkey/Hotkey Security: https://docs.bittensor.com/getting-started/coldkey-hotkey-security |
| 74 | +- Working with Keys: https://docs.bittensor.com/working-with-keys |
| 75 | +- Multisig Security: https://docs.bittensor.com/keys/multisig |
| 76 | +- Coldkey Rotation: https://docs.bittensor.com/subnets/schedule-coldkey-swap |
| 77 | + |
| 78 | +## Network Environments |
| 79 | +### Endpoints |
| 80 | +- Mainnet: wss://entrypoint-finney.opentensor.ai:443 |
| 81 | +- Testnet: wss://test.finney.opentensor.ai:443 |
| 82 | +- Devnet: wss://dev.chain.opentensor.ai:443 |
| 83 | + |
| 84 | +## Advanced Topics |
| 85 | +### Local Development |
| 86 | +- Local Subtensor Deployment: https://docs.bittensor.com/local-build/deploy |
| 87 | + |
| 88 | +### Subtensor Nodes |
| 89 | +- Node Basics: https://docs.bittensor.com/subtensor-nodes/ |
| 90 | +- Node Requirements: https://docs.bittensor.com/subtensor-nodes/subtensor-node-requirements |
| 91 | +- Source Installation: https://docs.bittensor.com/subtensor-nodes/using-source |
| 92 | +- Docker Installation: https://docs.bittensor.com/subtensor-nodes/using-docker |
| 93 | +- Rate Limits: https://docs.bittensor.com/subtensor-nodes/subtensor-rate-limits |
| 94 | +- Storage Queries: https://docs.bittensor.com/subtensor-nodes/subtensor-storage-query-examples |
| 95 | +- Error Messages: https://docs.bittensor.com/subtensor-nodes/subtensor-error-messages |
| 96 | + |
| 97 | +### EVM Integration |
| 98 | +- EVM on Bittensor Overview: https://docs.bittensor.com/evm-tutorials/ |
| 99 | +- EVM on Subtensor: https://docs.bittensor.com/evm-tutorials/evm-on-subtensor |
| 100 | +- Installation: https://docs.bittensor.com/evm-tutorials/install |
| 101 | +- Setup: |
| 102 | + - Hardhat Config: https://docs.bittensor.com/evm-tutorials/hardhat-config-for-subtensor-evm |
| 103 | + - Testnet: https://docs.bittensor.com/evm-tutorials/evm-testnet-with-metamask-wallet |
| 104 | + - Localnet: https://docs.bittensor.com/evm-tutorials/evm-localnet-with-metamask-wallet |
| 105 | + - Mainnet: https://docs.bittensor.com/evm-tutorials/evm-mainnet-with-metamask-wallet |
| 106 | +- Precompiles: |
| 107 | + - Metamask to SS58: https://docs.bittensor.com/evm-tutorials/transfer-from-metamask-to-ss58 |
| 108 | + - Between H160 Accounts: https://docs.bittensor.com/evm-tutorials/transfer-between-two-h160-accounts |
| 109 | + - Staking Precompile: https://docs.bittensor.com/evm-tutorials/staking-precompile |
| 110 | + - ED25519 Verify: https://docs.bittensor.com/evm-tutorials/ed25519-verify-precompile |
| 111 | + |
| 112 | +### Governance |
| 113 | +- Overview: https://docs.bittensor.com/governance |
| 114 | +- Senate: https://docs.bittensor.com/senate |
| 115 | +- Senator Guide: https://docs.bittensor.com/governance/senators-btcli-guide |
| 116 | + |
| 117 | +### Dynamic TAO |
| 118 | +- Guide: https://docs.bittensor.com/dynamic-tao/dtao-guide |
| 119 | +- SDK Cheat Sheet: https://docs.bittensor.com/dynamic-tao/sdk-cheat-sheet |
| 120 | + |
| 121 | +## Releases |
| 122 | +### Bittensor |
| 123 | +- PyPI: https://pypi.org/project/bittensor/ |
| 124 | +- GitHub: https://github.com/opentensor/bittensor/releases |
| 125 | + |
| 126 | +### BTCLI |
| 127 | +- PyPI: https://pypi.org/project/bittensor-cli/ |
| 128 | +- GitHub: https://github.com/opentensor/btcli/releases |
| 129 | + |
| 130 | +### Subtensor |
| 131 | +- GitHub: https://github.com/opentensor/subtensor/releases |
| 132 | + |
| 133 | +## Additional Resources |
| 134 | +- Glossary: https://docs.bittensor.com/glossary |
| 135 | + |
0 commit comments