Skip to content
This repository was archived by the owner on May 7, 2025. It is now read-only.

Commit 3a1241d

Browse files
author
Lukas Puehringer
committed
Update main README
fixes #33 - removes duplicate contribution instructions - adds info about the repo - adds link to hosted contribution instructions Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
1 parent cb60e44 commit 3a1241d

1 file changed

Lines changed: 4 additions & 13 deletions

File tree

README.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,6 @@
1-
# How to Add Documentation
1+
# Lind Project website
22

3-
This doc is using the `material` for `mkdocs`, which turns markdown files into an online doc website.
3+
The Lind Project website is built with [`mkdocs`](https://www.mkdocs.org/) and hosted on *GitHub pages*: [lind-project.github.io/lind-wasm-docs](https://lind-project.github.io/lind-wasm-docs/).
44

5-
**You should have `mkdocs` installed on your terminal first.**
6-
7-
**Do not edit on `gh-pages` branch, this is updated by github action automatically.**
8-
9-
To add a new seperate page of documentation, you need to
10-
11-
1. add a new `.md` markdown file to the `docs/` directory
12-
2. in the `mkdocs.yml` file's `nav:` section, add a the new page's path
13-
3. **IMPORTANT**: test if the changes works as expected by running `mkdocs serve` in the root directory of this repo, only push the changes after checking it works
14-
15-
NOTE: a github action of compiling these markdown files has already been setup. Once the changes of `.md` files are pushed, the static website branch will be automatically updated shortly.
5+
## Contributing
6+
See ["How to Add Documentation"](https://lind-project.github.io/lind-wasm-docs/contribute/writeDoc/) for instructions.

0 commit comments

Comments
 (0)