3 ms·
Good points, but I was thinking of something more curated and streamlined than documentation. Perhaps Sphinx meets Bespoke.js (http://markdalgleish.com/projects
by MalcolmDiggs 12y ago
Good points, but I was thinking of something more curated and streamlined than documentation. Perhaps Sphinx meets Bespoke.js (http://markdalgleish.com/projects/bespoke.js/ http://markdalgleish.com/projects/bespoke.js/)
- lifeisstillgood 12y agoGlossing over the private repo issue for a moment, and bein totally GitHub centric 1. Have each repo contain a 'presentation.rst' file, and they have simple format - header, '.. literalinclude' directives (done right) and commentary. Other highlights can be comments on issues, comments on pull requests etc 2. The presentation is formed in js/doco style with two columns - code on one, commentary on another. 3. Timelines that show where the literalinclude was committed, and along which are the other highlights in some rollover form 4. The whole timeline is created from all the presentation.rat files in all the listed repos. 5. Why not link in blog posts as highlights too? Any URL could easily be linked, with a commentary This is looking fun
- MalcolmDiggs 12y agoVery nice, and I love how it's github-centric (and you could incorporate it into your workflow). OP: whaddya think? Is this trending in the direction you were thinking?
- dennybritz 12y agoYep, this is great. I'm drafting up some specs now :)