3 ms·
Sure, keep the files as plain text in the repo, I'm all for that. Just don't make it the main interface for viewing them. You are really arguing that a GitHub f
by forsaken 13y ago
Sure, keep the files as plain text in the repo, I'm all for that. Just don't make it the main interface for viewing them. You are really arguing that a GitHub file browser is the best UX for viewing documentation?
Sure, keep documentation about code in the source code. Where exactly in the source code does your tutorial go?
You seem to be reading into a lot of things that aren't in the article based on what you want to hear.
- massysett 13y agoless(1) vi(1) emacs(1) firefox(1) google-chrome(1) Microsoft Word or Internet Explorer, if that's your thing! As for "where does your tutorial go," see for example "Control.Pipes.Tutorial". http://hackage.haskell.org/package/pipes-4.0.0/docs/Pipes-Tutorial.html http://hackage.haskell.org/package/pipes-4.0.0/docs/Pipes-Tu... If someone can't figure these things out, by all means, go use someone else's library. This sort of documentation would not be acceptable for a consumer product like TurboTax, but a programmer needs to know how to view a text file.
- lowboy 13y agoI know how to view a text file, or even navigate a directory of them. But as forsaken said, a GitHub file browser is often not the best UI for viewing documentation, especially when you're already in a browser. What's better, the docs for Backbone.Marionette[0], or Backbone[1]? [0]: https://github.com/marionettejs/backbone.marionette/tree/master/docs https://github.com/marionettejs/backbone.marionette/tree/mas... [1]: http://backbonejs.org/ http://backbonejs.org/
- pseut 13y ago> What's better, the docs for Backbone.Marionette, or Backbone? Offline or online viewing? Should I need a web connection to read the documentation?