FEATURE : Documentation #22
Description
What for
It wil be great to include documentation and learning section to new front Cerberus.
Idealy the information tab should contain the sections :
- Documentation :
- User guid
- Developer guid
- Changelog - Learning
- User how to
- Developer how-to
- Tutorials
- FAQ
It should be great to include more sections than cerberus-source for simplify user life.
I recommend using a single format for all sections to standardize our documentation.
Our proposed solution
Tools
the tools we can use :
Asciidoc : markup langage to script all documentation
Asciidoctorjs : framework to compile html file from asciidoc file
Steps
First step to implements :
We can construct docs folder in project root :
-> create tree into "/src/" to store .adoc files
-> create tree into "/build/" to store generated html doc files
-> create bin folder / compile_documentation.bat to generate documentation build
Second step :
- Construct components to access docs/build folder and read html files.
We can display it in the tree of this type :
Finally :
It's great to include compile_documentation.bat in project build.
We begin POC locally,
give us your opinion in commentary to understand your expectations.
@Nouxx if you agree on our proceed method, i can commit the beginning of issues with the docs folder content.