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
Update README.md - Remove version so it's relevant w/o changes (AstarNetwork#543)
* Update README.md - Remove version so it's relevant w/o changes
* Update README.md
used this opportunity to polish and add instructions for Github Desktop users
* Update README.md
---------
Co-authored-by: Megan Skye Phoenix <58894568+meganskye@users.noreply.github.com>
Copy file name to clipboardexpand all lines: README.md
+15-14
Original file line number
Diff line number
Diff line change
@@ -2,13 +2,13 @@
2
2
3
3
Welcome to Astar Docs GitHub Repo.
4
4
5
-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
5
+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
6
6
7
-
## Instructions on how to contribute to Astar Docs using local instance of Docusaurus engine
7
+
## How to contribute to Astar Docs using a local instance of the Docusaurus engine
8
8
9
-
### Prereqs
9
+
### Prerequisites
10
10
11
-
- Make sure `git` and `yarn` exist as commands in your terminal/vscode: [https://yarnpkg.com/](https://yarnpkg.com/)**(NOTE: Please make sure you use yarn 1 (classic) by using command `yarn set version classic`**
11
+
-Method 1: Make sure `git` and `yarn` exist as commands in your terminal or VS Code: [https://yarnpkg.com/](https://yarnpkg.com/)**(NOTE: Please make sure you use yarn 1 (classic) by using command `yarn set version classic`**
12
12
- Git/Github: understand what the following commands do
@@ -18,14 +18,16 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
18
18
- titles, subtitles
19
19
- lists
20
20
- hyperlinks
21
+
22
+
- Method 2: Make sure `yarn` exists as a command in your terminal or VS Code and Github Desktop is installed. All the `git` operations described below can also be found within the menu of the desktop application, and common operations are clearly visible on launch.
-`yarn start` - spin up a realtime website that updates dynamically based on your changes to the code.
27
29
28
-
### New document / Modify existing docment --> Submit a PR
30
+
### New document / Modify existing document --> Submit a PR
29
31
30
32
- Get latest version of docs locally
31
33
- Make sure you’re on the main branch (`git checkout main`)
@@ -38,13 +40,13 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
38
40
- When you’re happy with it, ensure `yarn build` runs without errors
39
41
- PR and staging environment
40
42
- Commit your changes and push the new branch up to Github (`git add .` and `git commit`, `git push -u origin feat/your-new-branch`)
41
-
- Create New PR on Github (https://github.com/astarnetwork/astar-docs)
42
-
- Once PR is up, **CICD** will automatically build you a unique staging link you can see progress of this on Actions tab in Github
43
-
-Get feedback from team
43
+
- Create a new PR on Github (https://github.com/astarnetwork/astar-docs)
44
+
- Once PR is up, **CICD** will automatically build you a unique staging link. You can view the progress of this on the Actions tab on Github
45
+
-Wait for feedback from the team
44
46
45
47
### Working with images
46
48
47
-
- Please import and use tag`<Figure/>` instead of `![image]` as this enables smoother translation of docs to other languages (automatic reference to original images, no need to copy images to translated subfolders)
49
+
- Please import and use the`<Figure/>`tag instead of `![image]` as this enables smoother translation of docs to other languages (automatic reference to original images, no need to copy images to translated subfolders) and automatically applies some styling such as line breaks.
48
50
49
51
- Example - as seen [here](https://github.com/AstarNetwork/astar-docs/blob/d530139ca7a5ab034a783981d313542e02fdfb54/docs/about/token-economics/inflationary-model.md):
50
52
@@ -62,11 +64,10 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
62
64
63
65
### Deploy to production
64
66
65
-
- When PR is ready for merge, merge it by clicking the button at the bottom saying **Merge and Close**
66
-
- Should be soon available at `[https://docs.astar.network](https://docs.astar.network)`
67
+
- When a PR is ready for merge, click the button at the bottom saying **Merge and Close** and then **Confirm**
68
+
- After a few minutes you should see your changes updated on the production site at `[https://docs.astar.network](https://docs.astar.network)`
67
69
68
70
### HELP SOMETHING IS BROKEN
69
71
70
-
- Likely, a broken build got pushed to `main` somehow. Remove the commit from `main` and force push to `main`, reopen PR in a new PR
71
-
- Please make sure you use yarn 1 (classic) by using command `yarn set version classic`
72
+
- Likely, a broken build got pushed to `main` somehow. Remove the commit from `main` and force push to `main`, reopen PR in a new PR.
0 commit comments