Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
64 changes: 3 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,64 +8,6 @@

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

Welcome to Bittensor Developer Docs. These docs are built using [Docusaurus](https://docusaurus.io/). See the below instructions to build these docs locally.

## Basic

In most cases you only need to follow this basic approach. If you know what you are doing, also see the below [Advanced](#advanced) section.

### Installation

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

```
cd developer-docs
```

```
yarn
```

The above steps will install Docusaurus and all its dependencies on your local machine.

### Start a preview server

From the `developer-docs` directory run this command:

```
yarn start
```

The above command starts a local Docusaurus development server and opens up a browser window. Any changes you make within the `developer-docs` directory will be shown live in the browser window. You do not need to restart the server. Simply refresh the browser.

Follow the [WRITING STYLE GUIDE](./WRITING-STYLE-GUIDE.md) and stick to those writing style guidelines to make your contribution to these docs better.

## Advanced

### Build static html

```
yarn build
```

This command generates static content, including all the static html files and assets, into the `build` directory. You can then serve this `build` directory using any static hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

---
This repo is now a relic/archive. It was the original home of the open source docs for Bittensor, hosted at docs.bittensor.com
These docs are now hosted at docs.learnbittensor.org, and the open source repository is now at https://github.com/latent-to/developer-docs
This migration was executed June 18, 2025 by https://github.com/MichaelTrestman, head of Bittensor docs. Contact at m@latent.to or _trexman on discord.
151 changes: 0 additions & 151 deletions WRITING-STYLE-GUIDE.md

This file was deleted.

164 changes: 0 additions & 164 deletions docs/_components.md

This file was deleted.

Loading