Skip to content
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

Fix codeblocks. #234

Merged
merged 1 commit into from
Aug 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
70 changes: 27 additions & 43 deletions docs/protocol/pulsar.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If BTRFS is used with Subspace, the directory/whole file system must be CoW disa

**Command to Disable CoW on BTRFS**

```
```shell-session
sudo chattr +C path/to/data/dir
```

Expand All @@ -68,21 +68,21 @@ Creating a filesystem with a chunk (sunit) size of 32KB can prevent data fragmen

**XFS**

```
```shell-session
sudo mkfs.xfs -d su=32k,sw=1 /path/to/dev
```

Then use `largeio` and `swalloc` mount options.

**ext4**

```
```shell-session
sudo mkfs.ext4 -E stride=8,stripe-width=8 /path/to/dev
```

You can change these settings for an existing file system:

```
```shell-session
sudo tune2fs -E stride=8,stripe-width=8 /path/to/dev
```

Expand Down Expand Up @@ -313,35 +313,27 @@ To start we have to initialize our Farmer, this can be done with:
<TabItem value="macos" label="🍎 macOS">
Intel Chip:

```bash

```shell-session
./pulsar-macos-x86_64-v0.6.4-alpha init

```
Apple M Series:

```bash

```shell-session
./pulsar-macos-aarch64-v0.6.4-alpha init

```

</TabItem>

<TabItem value="linux" label="🐧 Ubuntu">
Ubuntu:

```bash

```shell-session
./pulsar-ubuntu-x86_64-skylake-v0.6.4-alpha init

```
Ubuntu Executable (aarch64):

```bash

```shell-session
./pulsar-ubuntu-aarch64-v0.6.4-alpha init

```

</TabItem>
Expand Down Expand Up @@ -438,17 +430,13 @@ To begin farming on the network, just run the `farm` command with the CLI like s

Intel Chip:

```bash

```shell-session
./pulsar-macos-x86_64-v0.6.4-alpha farm

```
Apple M1 Chip:

```bash

```shell-session
./pulsar-macos-aarch64-v0.6.4-alpha farm

```

</TabItem>
Expand All @@ -457,17 +445,13 @@ Apple M1 Chip:

Ubuntu:

```bash

```shell-session
./pulsar-ubuntu-x86_64-skylake-v0.6.4-alpha farm

```
Ubuntu Executable (aarch64):

```bash

```shell-session
./pulsar-ubuntu-aarch64-v0.6.4-alpha farm

```

</TabItem>
Expand Down Expand Up @@ -500,28 +484,28 @@ If you want to learn more about Tmux and its options check out their Repo [here]

* Create a new tmux session using a socket file named farming

```bash
```shell-session
$ tmux -S farming
```


* Move process to background by detaching
```bash
```text
Ctrl+b d OR ⌘+b d (Mac)
```

* To re-attach
```bash
```shell-session
$ tmux -S farming attach
```

* Alternatively, you can use the following single command to both create (if not exists already) and attach to a session:
```bash
```shell-session
$ tmux new-session -A -D -s farming
```

* To delete farming session
```bash
```shell-session
$ tmux kill-session -t farming
```

Expand All @@ -535,27 +519,27 @@ If you want to learn more about Screen and its options check out their Webpage [
:::

* Create new screen using a socket file named farming
```bash
```shell-session
$ screen -S farming
```

* Move process to background by detaching
```bash
```text
Ctrl+d a OR ⌘+d a (Mac)
```

* To re-attach
```bash
```shell-session
$ screen -r farming
```

* Alternatively, you can use the following single command to both create (if not exists already) and attach to a session:
```bash
```shell-session
$ screen -D -R -S farming
```

* To delete farming session
```bash
```shell-session
$ screen -S farming -X quit
```

Expand Down Expand Up @@ -584,7 +568,7 @@ To simply restart the node, go to the terminal where you started the `farm` comm

Use the same file name as the previous init and farm steps, then add the wipe command to free the previous storage that was being used. Generally, only do this if you have severe errors and are prompted by a staff member.

```bash
```shell-session
./pulsar-file-name wipe
```

Expand Down Expand Up @@ -618,7 +602,7 @@ Your Logs will be found in `$HOME/.local/share/pulsar/logs`

When running the Subspace Network Farmer & Node, sometimes you may encounter an error message that includes a line similar to the following:

```
```text
Backtrace omitted. Run with RUST_BACKTRACE=1 environment variable to display it.
```

Expand All @@ -635,7 +619,7 @@ To enable the `RUST_BACKTRACE` environment variable on Windows using PowerShell,

1. Open a PowerShell window.
2. Type the following command:
```bash
```powershell
$Env:RUST_BACKTRACE=1
```

Expand All @@ -652,7 +636,7 @@ To enable the `RUST_BACKTRACE` environment variable on macOS, follow these steps

1. Open a terminal window.
2. Type the following command:
```bash
```shell-session
export RUST_BACKTRACE=1
```

Expand All @@ -669,7 +653,7 @@ To enable the `RUST_BACKTRACE` environment variable on Linux, follow these steps

1. Open a terminal window.
2. Type the following command:
```bash
```shell-session
export RUST_BACKTRACE=1
```

Expand Down
24 changes: 12 additions & 12 deletions docs/protocol/substrate-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ If BTRFS is used with Subspace, the directory/whole file system must be CoW disa

**Command to Disable CoW on BTRFS**

```
```shell-session
sudo chattr +C path/to/data/dir
```

Expand All @@ -68,21 +68,21 @@ Creating a filesystem with a chunk (sunit) size of 32KB can prevent data fragmen

**XFS**

```
```shell-session
sudo mkfs.xfs -d su=32k,sw=1 /path/to/dev
```

Then use `largeio` and `swalloc` mount options.

**ext4**

```
```shell-session
sudo mkfs.ext4 -E stride=8,stripe-width=8 /path/to/dev
```

You can change these settings for an existing file system:

```
```shell-session
sudo tune2fs -E stride=8,stripe-width=8 /path/to/dev
```

Expand Down Expand Up @@ -568,8 +568,8 @@ You can set a custom path for your node & farmer to use if you want to use an ex
To set your node to use a custom path all you will need to do is add the `--base-path` parameter.

```bash
# start node and store data in `NODE_DATA_PATH` instead of default location
./NODE_FILE_NAME --base-path NODE_DATA_PATH --chain gemini-3f ...`
# start node and store data in `NODE_DATA_PATH` instead of default location
./NODE_FILE_NAME --base-path NODE_DATA_PATH --chain gemini-3f ...`
```
</TabItem>
</Tabs>
Expand Down Expand Up @@ -633,7 +633,7 @@ Farm path and size you have seen above can be specified more than once to engage
It is recommended to specify multiple disks explicitly rather than using RAID for better hardware utilization and efficiency.

Example:
```bash
```shell-session
./FARMER_FILE_NAME farm --reward-address WALLET_ADDRESS \
path=/media/ssd1,size=100GiB \
path=/media/ssd2,size=10T \
Expand All @@ -648,7 +648,7 @@ NOTE: This is primarily targeted at tech-savvy users and not recommended unless
Please try to find answer to your question online before reaching out to maintainers.

You'll have to have [Rust toolchain](https://rustup.rs/) installed as well as LLVM, Clang and CMake in addition to usual developer tooling (Ubuntu example):
```bash
```text
sudo apt-get install llvm clang cmake
```

Expand All @@ -657,7 +657,7 @@ The build with LLVM + Clang 16 ends with `UnknownOpcode(192)` error due to break
:::

Now clone the source and build snapshot `snapshot-2023-aug-18` (replace occurrences with the snapshot you want to build):
```bash
```shell-session
git clone https://github.com/subspace/subspace.git
cd subspace
git checkout snapshot-2023-aug-18
Expand All @@ -680,7 +680,7 @@ If you are having some issues with running the node or the farmer for the subspa

When running the Subspace Network Farmer & Node, sometimes you may encounter an error message that includes a line similar to the following:

```
```text
Backtrace omitted. Run with RUST_BACKTRACE=1 environment variable to display it.
```

Expand Down Expand Up @@ -714,7 +714,7 @@ To enable the `RUST_BACKTRACE` environment variable on macOS, follow these steps

1. Open a terminal window.
2. Type the following command:
```bash
```shell-session
export RUST_BACKTRACE=1
```

Expand All @@ -731,7 +731,7 @@ To enable the `RUST_BACKTRACE` environment variable on Linux, follow these steps

1. Open a terminal window.
2. Type the following command:
```bash
```shell-session
export RUST_BACKTRACE=1
```

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ const config = {
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
additionalLanguages: ['toml'],
additionalLanguages: ['toml', 'powershell', 'shell-session'],
},
}),
};
Expand Down