The core code in this project has reached some degree of maturity, and I guess it's the right time to shift the attention to board support code, and to docs.
The following needs to be done:
- publish contents from notebooks, and also from this log, to the Wiki on GitHub
- restructure the Wiki without breaking links on external pages
- use custom GitHub sidebars and overview pages to make the contents accessible
- Enrich Wiki pages with diagrams, schematics, and photos
- Create a simple HowTo with a shopping list, and instructions that require "zero-problem-solving".
There is a page at GitHub that presents "Best Practice" for GitHub Wikis, but "Best" seems to stand for "use it for more than leaving an outdated boring Markdown wasteland", and "Practice" appears to mean "Improvise".
Documentation in a uniform and manageable way calls for a CMS, but a good folder structure and templates will do the job. I like the method used in this Wiki: it's based on sub-folders with local sidebars and locally stored images. It also shows that it takes quite some discipline to make it effective.
EDIT: I'm on a business trip, so no hacking :-{ Some of the docs on GitHub received an update.
There are some more boards in the pipeline. XH-W1401 is half-ready, and I can start with XH-W1219 or XH-1701. In order to improve accessibility to information it's maybe better to create some more HaD sub-projects.
My idea is:
- simple control boards (e.g. thermostats),
- voltmeters
- power supplies
- other boards here (unless they require more work)
Discussions
Become a Hackaday.io Member
Create an account to leave a comment. Already have an account? Log In.