Skip to content

Commit 217d5f7

Browse files
committed
Update README
1 parent 0a8862c commit 217d5f7

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
1-
# Website
1+
# ETM Documentation
22

3-
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
3+
Please update your links: documentation is now published and searchable at **https://docs.energytransitionmodel.com**
44

5-
### Installation
5+
This repository contains the source for the [ETM Docs website](https://docs.energytransitionmodel.com). It's built using Docusaurus 2; please see [Installation](#installation) for instructions on getting up-and-running.
6+
7+
## Adding documentation
8+
9+
Please see [the published documentation](https://docs.energytransitionmodel.com/contrib/authoring-docs) for details on how to add, change, and remove documents ([in-repo link](https://github.com/quintel/documentation/blob/docusaurus/docs/contrib/authoring-docs.md)).
10+
11+
## Installation
12+
13+
If you wish to preview the site locally, you should [start by installing Yarn](https://yarnpkg.com/getting-started/install). Then running `yarn` will install the dependencies.
614

715
```
816
$ yarn
@@ -26,8 +34,4 @@ This command generates static content into the `build` directory and can be serv
2634

2735
### Deployment
2836

29-
```
30-
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
31-
```
32-
33-
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.
37+
Deployment happens automatically when your changes are pushed to the master branch.

0 commit comments

Comments
 (0)