2020-10-15 - Write the Docs
Topic Leader(s)
Topic Overview
During that presentation host shows how to work with documentation in more efficient way.
Slides & Recording
Minutes
Jakob presented tools which is used by him to create *.rst files with preview mode and syntax highlights. He uses Visual Studio Code with reStructuredText extension.
Host shows us also the advantage of Read the docs usage over other solutions (like Confluence).
Couple of comments from audience:
- some support may be needed with VSC with it's extension usage for documentation project members,
- https://pypi.org/project/doc8/ tool usage recomendation
- there was a conculsion that there is a field for optimization, because nowadays each project maintainces it's documentation itself and it's probably the best solution
Action Items
, multiple selections available, Use left or right arrow keys to navigate selected items