I needed it for one of my projects and so I whipped up this simple documentation generator. It takes your README.md and turns it into an easier to navigate documentation site. Meant to be used on a gh-pages branch.
I created it manually using FreeMind. I basically just copied and pasted each section from the docs, and then grouped some of them together in logical ways to make it easier to read. I also deleted most of the usage notes about how previous versions worked, since I was starting with the newest so all of that was irrelevant to me.
Thank you. I've used it, although it adds a lot of complexity for the same features than a folder full of manuals would give.
I'm probably too set in my ways, but I prefer references that are always available offline. Devdocs.io once in a blue moon would forget about my choices, and I would hate to redownload them.
I just used the official docs and guides they had on the website, they seemed pretty good to me. I might have googled a few extra things, but can't really remember, I just remember it being pretty straightforward. I remember they pointed out a number of things you had to take care of.
The documentation would describe how to go from a recently formatted computer, the source code of the project and a list of off the shelf software with the necessary licences to the final product in a ready to ship and run condition.
If internal servers are involved, the way to setup these servers from scratch should be included too.
Now that I have all the parts, I can deal with the rest.
Yes, actually the Sketch Manual [1] (but who reads the manual?) and (my favorite) community resources [2] that you can download, play with, and re-use over and over.
The guides are good, but I'm missing the whole put it all together to make a real app tutorial type level of documentation. Can you point me to something like that?
The man pages to NetBSD. I don't think I've seen such comprehensive documentation in all my born days. Every command, API, data structure, and concept in the base system is thoroughly documented. I managed to write a toy device driver and incorporate it into the kernel, using nothing but the man pages.
reply