Skip to content

Commit f460385

Browse files
akbaddanielrudn
andauthored
refactor(README): refine formatting and overhaul content (#26)
* refactor(README): refine formatting and overhaul content * fix(docs): use correct link for deploy action --------- Co-authored-by: Daniel Rudnitski <danielrudn@gmail.com>
1 parent d515a6d commit f460385

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

README.md

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,35 @@
11
# Website
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
## Development
44

5-
### Installation
5+
### Adding content
66

7-
```
8-
$ yarn
9-
```
10-
11-
### Local Development
7+
We use [Docusaurus](https://docusaurus.io/) within these docs.
128

13-
```
14-
$ yarn start
15-
```
9+
- You can find a [general set of guides to Docusaurus here](https://docusaurus.io/docs/category/guides).
10+
- **Docusaurus provides extra cool formatting features** on top of vanilla Markdown,
11+
see the [guide to these features here](https://docusaurus.io/docs/markdown-features).
1612

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
13+
### Running the server
1814

19-
### Build
15+
Install deps and run the dev server locally by running:
2016

21-
```
22-
$ yarn build
17+
```sh
18+
yarn
19+
yarn start
2320
```
2421

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
### Deployment
22+
Most changes are reflected live without having to restart the server.
2823

29-
Using SSH:
24+
## Building
3025

31-
```
32-
$ USE_SSH=true yarn deploy
26+
```sh
27+
yarn build
3328
```
3429

35-
Not using SSH:
30+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
3631

37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
32+
## Deploying
4033

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
34+
- Deploying to GitHub Pages occurs automatically upon merges to `main`.
35+
- Check the [list of all `Deploy to GitHub Pages` workflow runs](https://github.com/ibm-skills-network/portals-admin-knowledgebase/actions/workflows/deploy.yml) to ensure your changes are successfully deployed after they're merged.

0 commit comments

Comments
 (0)