Documentation update #471
Documentation update #471
Conversation
- Basic pages on how to use the pipeline. - New screenshots. - Activated MathJax - Added template new pages.
* Two images added.
- Minor edits to other sections. - Split output content.
- Minor edits to other sections. - Added many new screenshots for docs.
|
@srggrs @marxide I have finally got to a point where I think everything is covered... See the top post in this PR for details (basically I highly recommend just running the local mkdocs server and looking through that way as it's a lot of new content - feel free to make changes direct to this branch). One TODO: I've added a link to the docs to the pipeline navbar but I'm not sure what the link is so I've left it blank for now. |
There was a problem hiding this comment.
Didn't have time to go through all of it in details. Just read quickly through. Minor comments.
Well done! I think you added plenty of info! Thank you very much!
One minor thing to make things slim, would be to move the Mathjax js code from javascripts/config.js to theme/js/extra.js
- New docs dependency of `mkdocs-gen-files`. - Auto generates pages using `mkdocs-gen-files`. - Updated non-google format docstrings to google format.
Co-authored-by: Serg <[email protected]>
Thanks! I have shifted where the Mathjax code lives in d674012. |
Co-authored-by: Andrew O'Brien <[email protected]>
Co-authored-by: Andrew O'Brien <[email protected]>
Thanks very much for going through that in detail! Especially for filling in the page links that I completely forgot to go back and do. I've committed all the suggestions. |
- Added missing command sections. - Changed titles to command names and made order consistent to list.
- Also added link to translators from the FAQ page.
Code reference documentation update
My long promised update to the documentation. I've added text and created the following heading sections:
I approached this as dumping as much knowledge and instruction as I could into the documentation with the view it can then be iterated and improved from this point.
Because there is a lot of change I would recommend running the mkdocs server locally and exploring it that way.
I expect there are a few spots of poor language in there in trying to get it done - please feel free to directly fix language to this branch or make suggestions to commit. Same goes for headings and layout, feel free to change it if you think something is not clear.