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

Commit a196875

Browse files
author
Lukas Puehringer
committed
Add contributing section and move related docs
* Add Contributing nav item / section * Add Contributing index page as first subitem in the section and mention source code and docs repos. * Move unit test guide, previously under "testing", and style guide and doc guide, previously under "more", under "contributing" section. Note: With Mkdocs a "section cannot have a page assigned to it", hence the workaround with the first page of the section repeating the section title (this pattern is also on the mkdocs user docs site - https://www.mkdocs.org/user-guide/). An alternative would be to use the section-index plugin: https://oprypin.github.io/mkdocs-section-index/ It seems quite popular and is likely safe to use (the mkdocs repo uses a different plugin from the same author). Signed-off-by: Lukas Puehringer <lukas.puehringer@nyu.edu>
1 parent 973dc1a commit a196875

5 files changed

Lines changed: 19 additions & 4 deletions

File tree

docs/contribute/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Contributing
2+
3+
The Lind sandbox is developed in the [lind-wasm](https://github.com/Lind-Project/lind-wasm)
4+
monorepo on GitHub. You can find the documentation assets, including this site,
5+
in [lind-wasm-docs](https://github.com/Lind-Project/lind-wasm-docs). Please
6+
contribute to the Lind project by submitting issues or pull requests to these
7+
repositories.
8+
9+
More detailed guidelines about writing code, tests and documentation are below:
10+
11+
* [Rust Style Guide](styleguide.md)
12+
* [Unit Tests](unit-tests.md)
13+
* [Adding to the docs](writeDoc.md)
File renamed without changes.
File renamed without changes.
File renamed without changes.

mkdocs.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,16 @@ nav:
2424
- Compile Programs: use/compile-programs.md
2525
- Debug Programs: use/debug-programs.md
2626
- Run Programs: use/run-programs.md
27-
- Testing:
28-
- Unit tests: testing/unit-tests.md
27+
- Contributing:
28+
- contribute/README.md
29+
- Rust style guide: contribute/styleguide.md
30+
- Unit tests: contribute/unit-tests.md
31+
- Adding to the docs: contribute/writeDoc.md
2932
- More:
3033
- Maintainers: more/maintainers.md
31-
- Adding to the docs: more/writeDoc.md
32-
- Style Guide: more/styleguide.md
3334
- Community: community.md
3435

36+
3537
# - Progress: daily.md
3638
# - WASM Knowledge:
3739
# - understandTls.md

0 commit comments

Comments
 (0)