07-21-2018, 04:21 AM
Hi,
I think tutorials should be a different subject than the main documentation. Main docs should be a comprehensive reference of all features, a kind of user's manual. Tutorials are a collection of unrelated topics, each one focusing on a particular task or goal shown step by step.
I think that our first task should be deciding how to write them: LibreOffice document? Hand-made HTML? Markdown?
A good option is Markdown, because both Doxygen and GitHub can take it and present them nicely. My forever work-in-progress of the documentation is in Markdown format too. VSCode has built-in support for previews and syntax highlight.
What do you think?
I think tutorials should be a different subject than the main documentation. Main docs should be a comprehensive reference of all features, a kind of user's manual. Tutorials are a collection of unrelated topics, each one focusing on a particular task or goal shown step by step.
I think that our first task should be deciding how to write them: LibreOffice document? Hand-made HTML? Markdown?
A good option is Markdown, because both Doxygen and GitHub can take it and present them nicely. My forever work-in-progress of the documentation is in Markdown format too. VSCode has built-in support for previews and syntax highlight.
What do you think?