Skip to content

Commit 7f49472

Browse files
andabakmeganskye
andauthored
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>
1 parent 48a5875 commit 7f49472

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
Welcome to Astar Docs GitHub Repo.
44

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.
66

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
88

9-
### Prereqs
9+
### Prerequisites
1010

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`**
1212
- Git/Github: understand what the following commands do
1313
- managing branches (`git checkout main` and `git checkout -b feat/your-new-branch`
1414
- Commits (`git add .` and `git commit`, `git push -u origin feat/your-new-branch`)
@@ -18,14 +18,16 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
1818
- titles, subtitles
1919
- lists
2020
- 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.
2123

2224
### Setup: First time only
2325

2426
- Clone repo `git clone https://github.com/astarnetwork/astar-docs`
2527
- Install dependencies by running `yarn` (`cd astar-docs` , `yarn` )
26-
- `yarn start` - spin up realtime website
28+
- `yarn start` - spin up a realtime website that updates dynamically based on your changes to the code.
2729

28-
### New document / Modify existing docment --> Submit a PR
30+
### New document / Modify existing document --> Submit a PR
2931

3032
- Get latest version of docs locally
3133
- 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
3840
- When you’re happy with it, ensure `yarn build` runs without errors
3941
- PR and staging environment
4042
- 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
4446

4547
### Working with images
4648

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.
4850

4951
- Example - as seen [here](https://github.com/AstarNetwork/astar-docs/blob/d530139ca7a5ab034a783981d313542e02fdfb54/docs/about/token-economics/inflationary-model.md):
5052

@@ -62,11 +64,10 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern sta
6264
6365
### Deploy to production
6466
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)`
6769
6870
### HELP SOMETHING IS BROKEN
6971
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.
7273

0 commit comments

Comments
 (0)