Re:Code documentation written as code
by Nilzor on Monday August 12, 2013 @05:45AM
(#6198421)
Exactly what am I looking at here? I think if you want attention to your HN-posts you should put a bit more effort into it than simply linking to a git repo.
Re:Code documentation written as code
by pwg on Monday August 12, 2013 @06:14AM
(#6198489)
One of github's UI flubs, in my opinion, is that the main repo page puts the code file name listing at the top, and the "README" at the bottom, so with any substantial repository, one has to scroll down "below-the-fold" before one gets to the description part of the page.
A reasonable (somewhat) interface for contributors. A very lacking UI for promoting the value of the code base to non-contributors.
Re:Code documentation written as code
by npsimons on Monday August 12, 2013 @10:35AM
(#6199398)
"Attention is scarce. Information is not. Do the math." - Nina Paley
Just because something makes it to the frontpage of HN doesn't automatically make it worthy of further investigation. Granted, one shouldn't just fling things aside because they have no immediately apparent utility, but just from the difference in the submitted headline and the first line of the linked to page, this smells a bit of coder-drama.
Re:Code documentation written as code
by spindritf on Monday August 12, 2013 @04:43AM
(#6198245)
This is a really great format which lends itself to a whole range of mid-to-low level computer tasks. Programming/scripting, obviously, but now there's a tools section which I'm guessing will also catch on. You could describe ip(6)tables like that, or ssh.
A reasonable (somewhat) interface for contributors. A very lacking UI for promoting the value of the code base to non-contributors.
https://github.com/adambard/learnxinyminutes-docs#readme
Just because something makes it to the frontpage of HN doesn't automatically make it worthy of further investigation. Granted, one shouldn't just fling things aside because they have no immediately apparent utility, but just from the difference in the submitted headline and the first line of the linked to page, this smells a bit of coder-drama.
Also didn't realize that the site had been posted before. :S