This repository was archived by the owner on May 7, 2025. It is now read-only.
Commit a196875
Lukas Puehringer
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
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
File renamed without changes.
File renamed without changes.
File renamed without changes.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
28 | | - | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
29 | 32 | | |
30 | 33 | | |
31 | | - | |
32 | | - | |
33 | 34 | | |
34 | 35 | | |
| 36 | + | |
35 | 37 | | |
36 | 38 | | |
37 | 39 | | |
| |||
0 commit comments