DigitPaint / roger

Roger is your friendly front-end development toolbox!
MIT License
4 stars 4 forks source link

Rethink changelog and documentation deliverables #16

Closed edwinvdgraaf closed 9 years ago

edwinvdgraaf commented 9 years ago

The generation of documentation, TOC and changelog that are delivered are still depended on copy-paste from earlier projects. To ease the process, we should reconsider how we work with this. As an artefact of earlier mockup versions we still rely on injecting the changelog, we could leverage Tilt here for example. Currently we lack syntax highlighting for example. This is just an example however, I am interested in the problems people experience while using roger in their workflow.

For the moment I will focus my effort on creating a generate command for these _doc files, however feedback is very appreciated!

edwinvdgraaf commented 9 years ago

Another often requested feature is the ability to download the package directly from the reference HTML. Also versioning comes to mind.

flurin commented 9 years ago

I don't believe in generators for this; this should be automated in middleware / processor steps so they'll ALWAYS be there

flurin commented 9 years ago

Made issue #18 for download of packages.

edwinvdgraaf commented 9 years ago

Closing this issue in favor of some smaller ones.

For syntax highlgihting there is now https://github.com/DigitPaint/roger_better_markdown