tlang
/
documentation
mirror of https://github.com/tbklang/documentation
1
0
Fork 0
Code Issues 3 Packages Projects 2 Releases Activity

- Added notes on contributing

This commit is contained in:
Tristan B. Velloza Kildaire 2023-07-09 21:11:04 +02:00
parent c073fb5eb4
commit 75f3f0b70d
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -12,3 +12,19 @@ mkdocs serve
``` ```
In the root of the repository, if you get an error you will need to install some PIP dependencies. In the root of the repository, if you get an error you will need to install some PIP dependencies.
## Contributing
If you would like to edit the documentation then please edit the files in `docs_src/` (and **NOT** in `docs/`). The former folder
is used for the base documentation files and the latter is the result of the post-processing needed to be applied to the Markdown
files before they can be used for generating the LaTeX-based book or the Mkdocs website.
Once you have finished making your changes in the files in `docs_src/`, please then run the post-processing script:
```bash
./makemarkdown.sh
```
This should produce an updated file in `docs/` with the same name as the one you edited in `docs_src/`, **commit BOTH files** please.
Then you're done!