Skip to content

Nixprematureyc3bog #600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 50 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
447f435
fix: update lock file
clementblaise May 14, 2025
65366b9
fix: rebuild lock file
clementblaise May 14, 2025
5f86e48
fix: add and update packageManager
clementblaise May 14, 2025
0651dd6
fix: add missing dependencies
clementblaise May 14, 2025
d158729
fix: add missing dependencies
clementblaise May 14, 2025
befb195
fix: update Unlisted import
clementblaise May 14, 2025
272d142
fix: bump version
clementblaise May 14, 2025
50f86e0
fix: bump version
clementblaise May 14, 2025
3dda9dc
fix: bump version
clementblaise May 14, 2025
d67547f
fix: update import
clementblaise May 14, 2025
6686387
fix: update import
clementblaise May 14, 2025
53cdafd
fix: update useDoc import
clementblaise May 14, 2025
edaad75
fix: update useSidebarBreadcrumbs import
clementblaise May 14, 2025
33297ef
fix: add .cfignore
clementblaise May 14, 2025
749729f
fix: remove .cfignore
clementblaise May 14, 2025
288bd66
Merge pull request #1 from latent-to/cloudflare-pages-deployment
MichaelTrestman May 16, 2025
97e420e
wip
MichaelTrestman Jun 5, 2025
3a47526
create-yc3-blog
MichaelTrestman Jun 6, 2025
e761248
wip
MichaelTrestman Jun 9, 2025
c9074a4
wip
MichaelTrestman Jun 9, 2025
808ab47
wip
MichaelTrestman Jun 9, 2025
7a9a148
wip
MichaelTrestman Jun 9, 2025
48c17c8
wip
MichaelTrestman Jun 9, 2025
a0b7b16
wip
MichaelTrestman Jun 9, 2025
1a1c6c4
wip
MichaelTrestman Jun 9, 2025
0644c19
wip
MichaelTrestman Jun 9, 2025
26cd7ce
Merge pull request #3 from latent-to/yc3-blog
MichaelTrestman Jun 9, 2025
e8bfc49
wip
MichaelTrestman Jun 10, 2025
772d521
wip
MichaelTrestman Jun 10, 2025
3f62bf0
Merge pull request #5 from latent-to/catchup
MichaelTrestman Jun 10, 2025
a27c77a
wip
MichaelTrestman Jun 10, 2025
28110ee
Merge pull request #6 from latent-to/catchup
MichaelTrestman Jun 10, 2025
d286cf9
docs: wip
chideraao Jun 11, 2025
5207f36
docs: final copy
chideraao Jun 11, 2025
7ba0afa
added package-lock.json
chideraao Jun 11, 2025
9377980
wip
MichaelTrestman Jun 11, 2025
1d65920
Update WRITING-STYLE-GUIDE.md
chideraao Jun 11, 2025
c86758a
docs: repo link edits
chideraao Jun 11, 2025
15a5528
Merge pull request #8 from latent-to/opentensor-to-latent
MichaelTrestman Jun 12, 2025
e65736d
deleted package-lock.json
chideraao Jun 13, 2025
af1f5dc
docs: dTAO updates cont'd
chideraao Jun 16, 2025
2318d8e
couple of typos
MichaelTrestman Jun 16, 2025
3fae4e7
Merge pull request #10 from latent-to/dtao-updates
chideraao Jun 16, 2025
0c6becb
add skip_pull env var
MichaelTrestman Jun 16, 2025
ea0cbf0
Merge pull request #11 from latent-to/skip_pull-env-var
MichaelTrestman Jun 16, 2025
42fc421
Update docs/staking-and-delegation/delegation.md
chideraao Jun 18, 2025
01ea188
Update docs/staking-and-delegation/delegation.md
chideraao Jun 18, 2025
53fd81e
Update docs/subnets/understanding-subnets.md
chideraao Jun 18, 2025
6235624
Merge pull request #9 from latent-to/docs-edits
chideraao Jun 18, 2025
45f2101
wip
MichaelTrestman Jun 18, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ docs/.obsidian
.docusaurus
.cache-loader
.yarnclean
.yarn
.pnp.cjs
.pnp.loader.mjs

# Misc
.DS_Store
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</a>
</h1>
<h2 align="center">Bittensor Developer Docs</h2>
<h3 align="center">https://docs.bittensor.com</h3>
<h3 align="center">https://docs.learnbittensor.org</h3>

-----------------------------------------------------------------------------

Expand All @@ -17,7 +17,7 @@ In most cases you only need to follow this basic approach. If you know what you
### Installation

```
git clone https://github.com/opentensor/developer-docs.git
git clone https://github.com/latent-to/developer-docs.git
```

```
Expand Down
4 changes: 2 additions & 2 deletions WRITING-STYLE-GUIDE.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<h1 align="center">
<a href="https://www.docs.bittensor.com">
<a href="https://www.docs.learnbittensor.org">
<img alt="Tao Logo" src="./static/img/tao-logo.png" />
</a>
</h1>
<h2 align="center">Writing Style Guide</h2>

-----------------------------------------------------------------------------

When you write a developer document for Opentensor Foundation, your audience should find your documentation readable, informative, and concise. To accomplish these goals, here below are a few helpful writing style recommendations. We encourage you to stick to the writing style described on this page.
When you write a developer document for the Bittensor documentation, your audience should find your documentation readable, informative, and concise. To accomplish these goals, here below are a few helpful writing style recommendations. We encourage you to stick to the writing style described on this page.

# General principles

Expand Down
31 changes: 15 additions & 16 deletions docs/_sphinx-gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Building and Publishing Bittensor Python Reference Docs with Sphinx
Install virtual env

python3 -m venv sphinx_venv
source sphinx_venv/bin/activate
source sphinx_venv/bin/activate

Install Sphinx and the required extensions

Expand All @@ -11,27 +11,26 @@ Do a "tar xvf sphinx-starter.tar" in a new directory. This will extract three fi
Run "pip install -r requirements.txt". This will install Sphinx and the required extensions.
Build docs locally

In the "source/conf.py" file, change line 67 (autoapi_dirs = ["/Users/rajkaramchedu/2scratch/bittensor/bittensor"]) and put in the path to your local Bittensor clone repo.
Also on line 28 of “source/conf.py”, put in your path for Python site-packages.
Run "make html". This will create a "build" directory and place reference html docs in it.
Open the docs with the command: open build/html/index.html and you will see all the reference docs, exactly like how the published version looks like, including CSS customizations.
When you edit a docstring in the Bittensor repo, run this command to delete old stuff and rebuild html: rm -r build && make html This will make sure the "build" directory is removed before rebuilding the docs, or else it will use the old stuff in the "build" directory, and we don't want that.
In the “source” directory, there are separate “index.rst” files for Wallet SDK, Bittensor SDK and for legacy docs. If you are generating Wallet API docs, then copy over the “index.rst.btwallet” into “index.rst” before you build the docs.
In the "source/conf.py" file, change line 67 (autoapi_dirs = ["/Users/rajkaramchedu/2scratch/bittensor/bittensor"]) and put in the path to your local Bittensor clone repo.
Also on line 28 of “source/conf.py”, put in your path for Python site-packages.
Run "make html". This will create a "build" directory and place reference html docs in it.
Open the docs with the command: open build/html/index.html and you will see all the reference docs, exactly like how the published version looks like, including CSS customizations.
When you edit a docstring in the Bittensor repo, run this command to delete old stuff and rebuild html: rm -r build && make html This will make sure the "build" directory is removed before rebuilding the docs, or else it will use the old stuff in the "build" directory, and we don't want that.
In the “source” directory, there are separate “index.rst” files for Wallet SDK, Bittensor SDK and for legacy docs. If you are generating Wallet API docs, then copy over the “index.rst.btwallet” into “index.rst” before you build the docs.
When you are ready to publish the docs, proceed to the below next step.

Publish the docs

To publish the docs on docs.bittensor.com, you will push the entire "build/html" directory into the docs repo. However, before you do that, remove the `html/_sources` directory. This directory contains reStructuredText source files and we don't want to version control them. So, do rm -r build/html/_sources first.
In the docs repo, https://github.com/opentensor/developer-docs/tree/main , this "html" directory is located in the "developer-docs/python-api" path. Always replace the entire "html" directory even if you updated a single word or letter in a docstring.
In the Markdown file that contains links to these Python reference docs and sections, you will use "pathname:///python-api/html/index.html" for linking to the homepage of the Python ref docs. See "docs/bt-api-ref.md" for examples.
To publish the docs on docs.bittensor.com, you will push the entire "build/html" directory into the docs repo. However, before you do that, remove the `html/_sources` directory. This directory contains reStructuredText source files and we don't want to version control them. So, do rm -r build/html/\_sources first.
In the docs repo, https://github.com/latent-to/developer-docs/tree/main , this "html" directory is located in the "developer-docs/python-api" path. Always replace the entire "html" directory even if you updated a single word or letter in a docstring.
In the Markdown file that contains links to these Python reference docs and sections, you will use "pathname:///python-api/html/index.html" for linking to the homepage of the Python ref docs. See "docs/bt-api-ref.md" for examples.

Conf.py

The "source/conf.py" is where all the configuration for docs generation is defined.
See Sphinx website here: https://www.sphinx-doc.org/en/master/index.html
We use Sphinx AutoAPI extension for docstrings to html generation. See the docs for the extension here: https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html
We use Sphinx Book Theme with additional custom CSS tweaks. Our custom CSS file is located in the `source/_static` directory. The Sphinx Book Theme docs are in https://sphinx-book-theme.readthedocs.io/en/stable/tutorials/get-started.html
Finally, we use Google style for docstrings. See the description here: https://github.com/opentensor/developer-docs/blob/main/WRITING-STYLE-GUIDE.md#python-docstrings
The "source/conf.py" is where all the configuration for docs generation is defined.
See Sphinx website here: https://www.sphinx-doc.org/en/master/index.html
We use Sphinx AutoAPI extension for docstrings to html generation. See the docs for the extension here: https://sphinx-autoapi.readthedocs.io/en/latest/reference/config.html
We use Sphinx Book Theme with additional custom CSS tweaks. Our custom CSS file is located in the `source/_static` directory. The Sphinx Book Theme docs are in https://sphinx-book-theme.readthedocs.io/en/stable/tutorials/get-started.html
Finally, we use Google style for docstrings. See the description here: https://github.com/latent-to/developer-docs/blob/main/WRITING-STYLE-GUIDE.md#python-docstrings

That's it. Happy documenting.

5 changes: 2 additions & 3 deletions docs/_subnet-pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ hide_table_of_contents: true
import { HiAcademicCap } from "react-icons/hi2";
import { SiRootssage } from "react-icons/si";


# Subnet Pages

This section presents key information for each subnet. Click on a subnet card to go to its details page.
This section presents key information for each subnet. Click on a subnet card to go to its details page.

:::tip Updating subnet details page
If your subnet details page need updates, then [submit a GitHub issue](https://github.com/opentensor/developer-docs/issues/new).
If your subnet details page need updates, then [submit a GitHub issue](https://github.com/latent-to/developer-docs/issues/new).
:::

<Cards>
Expand Down
21 changes: 9 additions & 12 deletions docs/bittensor-networks.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,12 @@ title: "Bittensor Networks"

The below table presents Bittensor networks and a few details:

| DESCRIPTION | MAINNET | TESTNET | DEVNET |
|:---------------------|:------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|
| **Chain URL** | wss://entrypoint-finney.opentensor.ai:443 | wss://test.finney.opentensor.ai:443 | wss://dev.chain.opentensor.ai:443 |
| **Example Usage** | Default | `btcli wallet swap_hotkey --subtensor.chain_endpoint wss://dev.chain.opentensor.ai:443` **or** `btcli wallet swap_hotkey --subtensor.network test` | `btcli wallet swap_hotkey --subtensor.chain_endpoint wss://dev.chain.opentensor.ai:443` |
| **Block processing** | One block every 12 seconds | One block every 12 seconds | One block every 12 seconds |
| **Mainnet Archive** | wss://archive.chain.opentensor.ai:443 | None | None |
| **Mainnet Lite** | wss://lite.chain.opentensor.ai:443 | None | None |
| **Experimental Mainnet Lite** | wss://lite.finney.test.opentensor.ai:443 | None | None |
| **Network Purpose** | For all | For all | **For OTF-internal development only** |
| **Faucet** | None | None | Available on internal project-basis |
| **Test TAO** | None | Available on request (not compatible with devnet test TAO) | Available internally on request (not compatible with testnet test TAO) |

| DESCRIPTION | MAINNET | TESTNET | DEVNET |
| :---------------------------- | :---------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------- |
| **Chain URL** | wss://entrypoint-finney.opentensor.ai:443 | wss://test.finney.opentensor.ai:443 | wss://dev.chain.opentensor.ai:443 |
| **Block processing** | One block every 12 seconds | One block every 12 seconds | One block every 12 seconds |
| **Mainnet Archive** | wss://archive.chain.opentensor.ai:443 | None | None |
| **Mainnet Lite** | wss://lite.chain.opentensor.ai:443 | None | None |
| **Experimental Mainnet Lite** | wss://lite.finney.test.opentensor.ai:443 | None | None |
| **Network Purpose** | Transactions with financial value | Test transactions with no value, constrained by tokenomics | Development and testing in fully user-controlled environment |
| **Test TAO** | None | Available on request (not compatible with devnet test TAO) | Available internally on request (not compatible with testnet test TAO) |
Loading