more documentation gold

Previous Topic Next Topic
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view

more documentation gold

Brandon West of SendGrid recently announced that he has helped the company open source their documentation. In a three part blog series worth its word count in gold, he explains the benefits, how they did it and what makes good documentation.

Why we open sourced our documentation::

Creating sustainable documentation with Jekyll::

What makes good documentation (cheat codes)::

Here are the docs:

I declare these posts required reading (for myself) ;)
Reply | Threaded
Open this post in threaded view

Re: more documentation gold

Really amazing links and really useful information. It has made me think in three possible extensions,

* the first one is to provide a way to make references to javadoc by providing a macro called for example javadoc::. Question: can I access to system env. from Asciidoctor files?
* the other one provide a macro to capture an screenshot of a webpage using for example WebDriver. So screens of documentation will be always updated. screen::
* add a block which can be used to add style to description of a method and its parameter, so in all documentation it looks with the same style.

And this leaves me to another question should we add two new repositories on github, one called asciidoctor-ruby-extensions and asciidoctor-java-extensions so all official extensions can be stored there?