You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: documentation/README.md
+8-83
Original file line number
Diff line number
Diff line change
@@ -9,103 +9,28 @@ The documentation is built using [Docusaurus 2](https://docusaurus.io/). The dep
9
9
10
10
## Installation
11
11
12
-
```shell
13
-
npm i
14
-
npm run setup
12
+
```console
13
+
yarn
15
14
```
16
15
17
-
This command checks out a local copy of the wiki and creates links to the content.
16
+
This command installs all needed dependencies.
18
17
19
18
## Local Development
20
19
21
-
```shell
22
-
npm start
20
+
```console
21
+
yarn start
23
22
```
24
23
25
-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
26
-
27
-
## Tear Down
28
-
29
-
```shell
30
-
npm run clean
31
-
```
32
-
33
-
This command deletes the local wiki and local links.
34
-
24
+
This command starts a local, wiki themed, development server and opens up a browser window. Most changes are reflected live without having to restart the server.
All the project documentation should be placed in the `docs` folder. If you wish to create a new document, you should create a new `.md` file in the corresponding folder. For example, if you wanted to add a new tutorial, you should create a new `.md` file in `docs/tutorials`:
53
-
54
-
```
55
-
documentation # Root directory of your site
56
-
└── blog
57
-
└── docs
58
-
├── welcome.md
59
-
└── tutorials
60
-
└── your_new_tutorials_name.md
61
-
62
-
```
63
-
64
-
You can find more information on docs in the [official docusaurus documentation](https://docusaurus.io/docs/docs-introduction).
65
-
66
-
## Blog
67
-
68
-
You should store all your blog posts in the `blog` directory. When creating a new blog post, please make sure to respect the file name structure which includes the posts date in YYYY_MM_DD format. For example, if you wanted to add a post dated July 28th, 2021, your new `.md` file should be prefixed with `2021_07_28`.
69
-
70
-
You can find more information on blog posts in the [official docusaurus documentation](https://docusaurus.io/docs/blog).
71
-
72
-
## Sidebar
73
-
74
-
As the project has multiple documentation pages and sections, these need to be organized. This is handled by the `sidebars.js` file. The `sidebars.js` file contain an ordered JSON formatted object which will be used to generate the project sidebar.
75
-
76
-
### Documents
77
-
78
-
You can add a new doc by adding a new object with type `doc` to the sidebar object:
79
-
80
-
```json
81
-
{
82
-
type: 'doc',
83
-
label: 'FAQ',
84
-
id: 'tutorials/your_new_tutorials_name',
85
-
}
86
-
```
87
-
where
88
-
89
-
*`type` should always be 'doc'.
90
-
*`label` should be your desired sidebar item's label.
91
-
*`id` is the item's identifier. The ID field should contain the parent folder/s, if any.
92
-
93
-
### Categories
94
-
95
-
You can add a new category by adding a new object with type `category` to the sidebar object:
96
-
97
-
```json
98
-
{
99
-
type: 'category',
100
-
label: 'Tutorials',
101
-
items: []
102
-
}
103
-
```
104
-
105
-
where
106
-
107
-
*`type` should always be 'category'.
108
-
*`label` should be your desired sidebar category's label.
109
-
*`items` is an array of [documents](#documents).
110
-
111
-
You can find more information on the sidebar and its components in the [official docusaurus documentation](https://docusaurus.io/docs/sidebar).
Copy file name to clipboardexpand all lines: documentation/docs/tooling/docker_private_network.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -164,7 +164,7 @@ A node that is used to expose ports via the host and to have a single attachment
164
164
165
165
##### Volumes
166
166
167
-
Docker Compose creates a `shimmerdb` volume to maintain a tangle even after tearing down the containers. Run `docker-compose down -v` to clear the volume.
167
+
Docker Compose creates a `mainnetdb` volume to maintain a tangle even after tearing down the containers. Run `docker-compose down -v` to clear the volume.
Copy file name to clipboardexpand all lines: documentation/docs/tutorials/setup.md
+8-8
Original file line number
Diff line number
Diff line change
@@ -160,7 +160,7 @@ docker-compose version 1.26.0, build d4451659
160
160
First, lets create a user defined bridged network. Unlike the already existing `bridge` network, the user defined one will have container name DNS resolution for containers within that network. This is useful if later we want to setup additional containers which need to speak with the GoShimmer container.
0 commit comments