Skip to content

Commit c2b7d82

Browse files
committed
Add Contributing section to README
1 parent 8acdf34 commit c2b7d82

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,19 @@
11
# hemlock-docs
22

3+
## Intro
4+
35
Here be documentation for the Hemlock mobile apps, and the Evergreen users and administrators that support them.
46

57
These docs are published to https://kenstir.github.io/hemlock-docs/ from the `main` branch and we built using [Docusaurus](https://docusaurus.io/).
8+
9+
## Contributing
10+
11+
1. Preview the site locally
12+
```bash
13+
npm ci
14+
npm start
15+
```
16+
1. Build and check for broken links
17+
```bash
18+
npm run build
19+
```

static/img/logo.svg

-1
This file was deleted.

0 commit comments

Comments
 (0)