eclipse-archived
Further improve documentation (strategy and Doxygen)
What else there is to improve documentation?
- [x] Define documentation strategy (what goes in .md files, what on hugo, what in Hugo server, what in doxygen, is there a wiki somewhere) --> see project review board #4 slides (Documentation)
- [ ] Restructure doxygen (e.g. in essentials first docu from .h then from .c might confuse user)
- [x] create examples section
- [x] write proper documentation for each example (e.g purpose of the example, HW ressources needed, how to build it and flash it)in the @details section
- [x] create boards section
- [ ] write proper documentation for each board (e.g. Introduce the board, the MCU, the peripherals supported, those not supported, where to buy etc.)
- [ ] write documentation for example c-cellular
FYI, I setup a Hugo server: kiso.rempler.de:1313 It's an Azure Ubuntu VM with a cronjob that pulls the Kiso repo every 5min. I propose to use that server temporary until we have the Eclipse Foundation setup ready. Thus, all links in our docu can point there instead of leading to nowhere.
Also, I edited https://github.com/Bosch-AE-SW/cddk-oss/wiki and pointed to the Hugo docu.
@laithnasser and @khalifima
- [ ] Why is the above checkbox "Restructure doxygen [...]" and all its sub-tasks ticked if you're still working on "#330 restructuring the doxygen documentation #419"?
- [ ] And why is this issue still in the backlog and not in the "in progress column"?
@HansUweRempler
i think i ticked them all by wrong , and i just know that i should change it to in progress. sorry for that .
Still open, e.g., examples and board docu missing. We believe we need a documentation owner that takes over the responsibility (inconsistencies, optics, understandabilty, etc.)