Inspired by this conversation:
I took some time to document
Select now that it has a stable release. We already had an overview and module documentation, but I wanted to add some more tutorial-focused content as well as some explanation-focused content around some of the unfamiliar ideas in the library.
The documentation site is here:
A thorough, beginner-friendly tutorial on creating a dropdown is here:
A faster-paced, more advanced tutorial on creating a typeahead is here:
An explanation of using a free query in Halogen (contributed by @monoidmusician) is here:
If any of you folks give this a read and notice ways it can be improved (too much information? too little? typos?) I would appreciate the feedback!
In addition to writing this documentation, I’ve set up a continuous integration process that builds the documentation site, which is itself quite full-featured. I’ll soon write about this process as it’s quite easy to have a beautiful, functional docs site hosted on GitHub pages for your library.
The general idea is that by lowering the difficulty to set up a documentation project like this we can make it a little easier to get started documenting your own libraries.