GitBook
3 views
Skip to first unread message
Louis Suárez-Potts
Mar 22, 2016, 6:19:05 PM3/22/16
to corinthiateam
Are people interested in using GitBook for dox? I've just been playing
around in it and it seems easy to use. As name suggests, it's linked
to GitHub. That could be useful.
Louis
--
Louis Suárez-Potts
Mobile: +1.416.625.3843 (ET)
Skype: louisiam
Twitter: @luispo
http://luispo.com/
around in it and it seems easy to use. As name suggests, it's linked
to GitHub. That could be useful.
Louis
--
Louis Suárez-Potts
Mobile: +1.416.625.3843 (ET)
Skype: louisiam
Twitter: @luispo
http://luispo.com/
Peter Kelly
Mar 25, 2016, 9:20:16 AM3/25/16
to corinthiateam
I does look interesting, and I’d be willing to give it a try. The main issue at the moment is getting documentation written in the first place ;) I’ve been trying to make a dent in this recently but progress has been slow. I plan to post initial versions of stuff on my blog, but that can then be subsequently integrated into a book format.
However, I think for code-level documentation, a better solution would be tsdoc (for TypeScript code) and doxygen (for C code) - since this lets us include the API documentation directly within the code.
PGP key: https://www.pmkelly.net/pgp-key
(fingerprint 5435 6718 59F0 DD1F BFA0 5E46 2523 BAA1 44AE 2966)
--
You received this message because you are subscribed to the Google Groups "CorinthiaTeam" group.
To unsubscribe from this group and stop receiving emails from it, send an email to corinthiatea...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.
Louis Suárez-Potts
Mar 26, 2016, 6:30:11 PM3/26/16
to Peter Kelly, corinthiateam
Ok.
I hadn’t come across it before and it was only inadvertently in this instance: The documentation of an app build was created using it. But outside of the supposed tight connexion to GitHub, there seemed little else really to recommend it.
BTW, once again, I urge paying a local tech writer to be a stenographer/writer for a few days, if only just to get the work started. One could also use OS X’s dictation tools—that works, btw, esp. for doctors, I’ve discovered, who must constantly write the equivalent of guides/reports for themselves, insurance, colleagues; and these are life/death words—but would also lead you, I’d guess, into a maze of tweaking.
-louis
I hadn’t come across it before and it was only inadvertently in this instance: The documentation of an app build was created using it. But outside of the supposed tight connexion to GitHub, there seemed little else really to recommend it.
BTW, once again, I urge paying a local tech writer to be a stenographer/writer for a few days, if only just to get the work started. One could also use OS X’s dictation tools—that works, btw, esp. for doctors, I’ve discovered, who must constantly write the equivalent of guides/reports for themselves, insurance, colleagues; and these are life/death words—but would also lead you, I’d guess, into a maze of tweaking.
-louis
Reply all
Reply to author
Forward
0 new messages