Skip to content

Commit a88e52d

Browse files
committed
chore(docsite): update README to latest dev
1 parent 92b63ac commit a88e52d

File tree

2 files changed

+39
-27
lines changed

2 files changed

+39
-27
lines changed

docs/website/Makefile

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: clean install build serve dev upgrade
1+
.PHONY: clean install build serve dev lint format upgrade update-current
22

33
package-lock.json:
44
npm install
@@ -27,6 +27,12 @@ clean:
2727
rm -rf build
2828
rm package-lock.json || true
2929

30+
lint:
31+
npm run pretty:check
32+
33+
format:
34+
npm run pretty:write
35+
3036
upgrade: clean install
3137
# Update to the latest version of react and react-dom when it is supported and does not create dependency conflicts
3238
npm install \
@@ -49,9 +55,3 @@ update-current:
4955
mv versioned_sidebars/version-updated-sidebars.json versioned_sidebars/version-maintained-sidebars.json
5056
# Remove the entry for the temporary version in the versions.json file
5157
sed -i '/updated/d' versions.json
52-
53-
lint:
54-
npm run pretty:check
55-
56-
format:
57-
npm run pretty:write

docs/website/README.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,56 @@
11
# Website
22

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

55
### Installation
66

7-
```
7+
```shell
88
$ make install
99
```
1010

11-
### Local Development
11+
### Build
1212

13+
```shell
14+
$ make build
1315
```
14-
$ yarn start
16+
17+
This command generates static content into the `build` directory and can be served using any static contents hosting
18+
service.
19+
20+
### Local Development
21+
22+
```shell
23+
$ make dev
1524
```
1625

1726
This command starts a local development server and opens up a browser window. Most changes are reflected live without
1827
having to restart the server.
1928

20-
### Build
29+
Alternatively, if you need to simulate GitHub pages hosting environment, you can run
2130

22-
```
23-
$ make build
31+
```shell
32+
$ make serve-static
2433
```
2534

26-
This command generates static content into the `build` directory and can be served using any static contents hosting
27-
service.
35+
This will create a production build and run it on a Python server as a static content.
2836

29-
### Deployment
37+
### Content versioning
3038

31-
Using SSH:
39+
This website gives access to two versions of the documentation:
3240

33-
```
34-
$ USE_SSH=true npx docusaurus deploy
35-
```
41+
- `current`:
42+
- Hosts the documentation of the latest Mithril distribution
43+
- Shown by default
44+
- Source code can be found in `./root`
45+
- `next`:
46+
- Hosts the documentation of the upcoming Mithril distribution under development
47+
- Accessible by selecting `Next` in the version dropdown in the navbar
48+
- Source code can be found in `./versioned_docs/version-maintained`
3649

37-
Not using SSH:
50+
#### Versions rotation
3851

39-
```
40-
$ GIT_USER=<Your GitHub username> npx docusaurus deploy
41-
```
52+
When releasing a new distribution, the `current` documentation content can be rotated by using the `next` version with the command:
4253

43-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to
44-
the `gh-pages` branch.
54+
```shell
55+
make update-current
56+
```

0 commit comments

Comments
 (0)