diff --git a/src/content/docs/explanations/start-here.mdx b/src/content/docs/explanations/start-here.mdx index b271001..1da7a43 100644 --- a/src/content/docs/explanations/start-here.mdx +++ b/src/content/docs/explanations/start-here.mdx @@ -41,7 +41,8 @@ Understanding governance and leadership systems: Understanding the core systems that power Torus: -- [Control Space](https://dev.docs.torus.network/v05/control-space/) — Foundational permission and capability framework + +- [Control Space](https://docs.torus.network/v05/control-space/) — Foundational permission and capability framework - [Permission System](https://docs.torus.network/v05/permissions/) — How agents interact and delegate authority - [Governance & DAO](https://docs.torus.network/concepts/governance-dao/) — Decision-making processes and community coordination - [Tokenomics](https://docs.torus.network/concepts/tokenomics/) — Economic model and emission mechanics diff --git a/src/content/docs/getting-started/setup-cli.mdx b/src/content/docs/getting-started/setup-cli.mdx deleted file mode 100644 index 4a2710e..0000000 --- a/src/content/docs/getting-started/setup-cli.mdx +++ /dev/null @@ -1,164 +0,0 @@ ---- -title: Setup Torus CLI -description: Learn how to setup the torus CLI. ---- - -import { Tabs, TabItem, Aside } from "@astrojs/starlight/components"; - -## Installation - - - - - - - To install the **`torus`** python package using `pip`, run: - - ```sh - pip install torusdk - ``` - - Alternatively, to add **`torus`** to your poetry project, use: - - ```sh - poetry add torusdk - ``` - - - To install the **`torus`** CLI with Nix, execute: - - ```sh - git clone https://github.com/renlabs-dev/torus-cli - cd torus-cli - nix profile install . - ``` - - - - -## Features - -**`torus`** offers a variety of features for token management and agent interaction: - -- Commands for managing keys, tokens, and agents -- Key management including creation and listing -- Token operations such as transferring and staking -- Agent management for registration, curation and updates -- Participation in governance processes - -## CLI Usage - -The **`torus`** CLI is structured as follows: - -```sh -torus [OPTIONS] COMMAND [ARGS] -``` - -#### Top-Level Subcommands - -- **`balance`**: Manage token balances and staking. -- **`key`**: Handle key creation and management. -- **`agent`**: Manage information and operations related to agents. -- **`network`**: Interact with network operations like block and proposal management. -- **`misc`**: Access miscellaneous information such as APR and circulating supply. -- **`proposal`**: Interactions with network proposals -- **`curator`**: Curator actions - -```sh -torus subcommand [OPTIONS] COMMAND [ARGS]... -``` - -## Examples - -### Retrieving Balance - -```sh -# Show staked, free and total balance. -torus balance show 5FgfC2DY4yreEWEughz46RZYQ8oBhHVqD9fVq6gV89E6z4Ea -``` - -### Creating a Key - -```sh -torus key create key_name -``` - -### Retrieving Key Info - -```sh -torus key show key_name - -# Add the `--show-private` flag to show sensitive fields like private key. -torus key show key_name --show-private -``` - -### Listing Keys - -```sh -# Lists the names and addresses of keys stored on disk. -torus key list -``` - -### List Keys With Balances - -```sh -# Lists keys stored on disk with their balance (free, staked and total). -torus key balances -``` - -### Retrieving Agent Information - -```sh -# Note that the agent has to be registered on the network. -torus agent info vali::calc [--balance] -``` - -### Retrieving Global Parameters - -```sh -torus network params -``` - -### Retrieving Circulating Supply - -```sh -# Gets all tokens then were ever emitted minus burned tokens. -torus misc circulating-supply -``` - -## Completions - -You can enable completions for your shell by running: - -```sh -# On bash -torus --install-completion bash -# On zsh -torus --install-completion zsh -``` - -## Contributing - -Bug reports and pull requests and other forms of contribution are welcomed and -encouraged! :) - -To report a bug or request a feature, please [open an issue on GitHub]. - -If you have any questions, feel free to ask on the [torus cli Discord channel]. - -To contribute to the codebase, using Poetry you can install the development dependencies with: - -```sh -poetry install --with dev -``` - -it can [require some environment-specific binaries to be installed][ruff-installation] - ---- - -[open an issue on GitHub]: https://github.com/renlabs-dev/torus-cli/issues/new/choose -[torus cli Discord channel]: https://discord.com/channels/1306654856286699590/1306654857046003716 -[ruff-installation]: https://docs.astral.sh/ruff/installation/ - \ No newline at end of file diff --git a/src/content/docs/getting-started/setup-wallet.mdx b/src/content/docs/getting-started/setup-wallet.mdx deleted file mode 100644 index f88467d..0000000 --- a/src/content/docs/getting-started/setup-wallet.mdx +++ /dev/null @@ -1,76 +0,0 @@ ---- -title: Setting Up a Wallet -description: Learn how to set up a wallet to manage your assets on Torus. ---- - -import { - Steps, - Aside, - CardGrid, - LinkCard, -} from "@astrojs/starlight/components"; - -## SubWallet - -This tutorial will guide you through setting up a wallet using the SubWallet extension, a popular non-custodial wallet for managing assets across multiple blockchains. - - - -1. ##### Install The SubWallet Extension - - 1. **Download the Extension**: Visit the [SubWallet download page](https://www.subwallet.app/download.html) and choose the appropriate extension for your browser (Chrome, Brave, Firefox, or Microsoft Edge). - 2. **Add to Browser**: Click on the download link and follow the prompts to add the SubWallet extension to your browser. - -2. ##### Create New Wallet - - 1. **Open SubWallet**: Click on the SubWallet icon in your browser’s extension area to open the wallet. - 2. **Create a Master Password**: You will be prompted to create a master password. This password is crucial as it encrypts your wallet data on your device for security. - 3. **Backup Your Seed Phrase**: After setting your password, you will receive a seed phrase. Write this down and store it in a secure location. This seed phrase is essential for recovering your wallet if you forget your password or lose access to your device. - - - -3. ##### Account Management - - 1. **Create or Import Accounts**: You can create a new account or import an existing one using the seed phrase. To create a new account, simply follow the prompts after initializing your wallet. - 2. **Manage Multiple Accounts**: SubWallet allows you to manage multiple accounts. You can switch between them, rename them, or manage their details as needed. - -4. ##### Connect To Torus - - 1. **Adding Torus Support**: Watch this video to learn how to setup your TORUS wallet - [Wallet setup tutorial from Omni Labs](https://www.youtube.com/watch?v=3JDQFYg0u_A&t=172s). - 2. **Sending Tokens**: Visit the [Torus wallet](https://wallet.torus.network/), connect your wallet, click on **Send** and specify the recipient and amount. - - - - - -## Support and Resources - -For further assistance, you can access detailed tutorials and user guides on the [SubWallet Documentation page](https://docs.subwallet.app/main). Additionally, community support is available through channels like Telegram, Discord, and YouTube. - -By following these steps, you can effectively set up and start using your SubWallet to manage, receive, and send assets across multiple blockchain networks, ensuring a secure and efficient digital asset management experience. - -#### Related Topics - - - - - - diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index baab4ab..1da82ad 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -21,27 +21,3 @@ The permission & delegation system enables agents to granularily specialize whil The v0.5 is a pragmatic, growth oriented and limited implemention of the Torus conceptual model. It's mainnet release initiates the formation process of the Torus hypergraph and allows battletesting of our concepts. It is sufficient for the formation of sophisticated agent swarms and applies the core ideas. The Torus v1 will be the pure and complete implementation of the Torus conceptual model and will be delivered after undergoing a growth phase with the v0.5. - - - - - - - -