Skip to content

Commit 12e22bb

Browse files
committed
Update repository locations
1 parent b3b6ccd commit 12e22bb

File tree

5 files changed

+168
-15
lines changed

5 files changed

+168
-15
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,31 @@
33
Technical documentation for the Frequency parachain.
44
The current documentation can be viewed in its compiled form at https://docs.frequency.xyz.
55
Alternatively, the latest iteration of the docs [can be viewed
6-
non-formatted here](https://github.com/LibertyDSNP/frequency-docs/tree/main/pages).
6+
non-formatted here](https://github.com/frequency-chain/docs/tree/main/pages).
77

88
For more information about Frequency, visit [frequency.xyz](https://www.frequency.xyz)
9-
or [Frequency on GitHub](https://github.com/LibertyDSNP/frequency)
9+
or [Frequency on GitHub](https://github.com/frequency-chain/frequency)
1010

1111
## Install
1212

1313
To build the generator locally, install [mdBook](https://github.com/rust-lang/mdBook.git)
1414
and [link checker](https://github.com/Michael-F-Bryan/mdbook-linkcheck). The link checker will run during build process and throw warnings for any broken internal
1515
or external links.
1616

17-
``` bash
17+
```bash
1818
cargo install mdbook
1919
cargo install mdbook-linkcheck
2020
npm install
2121
```
22+
2223
## Run
2324

2425
### (Option 1) Active Build and Serve via HTTP
2526

2627
To run the doc generator locally, actively build after each change and serve them
2728
via HTTP use the following command:
2829

29-
``` bash
30+
```bash
3031
npm run serve
3132
```
3233

@@ -35,9 +36,10 @@ in the browser at <http://localhost:3000>. Note, it will not automatically refre
3536
browser page after each change.
3637

3738
### (Option 2) Manual Build
39+
3840
To run the doc generator locally and preview the formatted docs from local files, use the following:
3941

40-
``` bash
42+
```bash
4143
npm run build
4244
```
4345

@@ -53,4 +55,4 @@ The CI will automatically deploy what's merged into `main`.
5355

5456
## Tools and Frameworks
5557

56-
* [mdBook](https://rust-lang.github.io/mdBook/) — create books with Markdown
58+
- [mdBook](https://rust-lang.github.io/mdBook/) — create books with Markdown

0 commit comments

Comments
 (0)