3 ms·
That seems like a great idea in principle, but for most small projects the GitHub page /is/ the documentation. If that weren't the case, you wouldn't see half a
by wyattpeak 8y ago
That seems like a great idea in principle, but for most small projects the GitHub page /is/ the documentation. If that weren't the case, you wouldn't see half a dozen links to GitHub pages to show off projects on HN each day.
It's all very well to talk about ideals, but you can't ignore reality in the process.
You're right, though, that you shouldn't have to scroll past it every time. I don't really know what the solution is, but having it there but going undiscovered is the worst of both worlds.
- X-Istence 8y agoIf you've read one README on Github, you know to scroll down to see it on every other project. I would argue that it's not a steep learning curve, and it's not like the hide the scrollbar... we scroll in other websites without issue when we are looking for content, especially with ads being most of the content above the fold these days.
- wyattpeak 8y agoI agree it's not much of a learning curve, but neither is learning which icon represents a commit. This entire discussion is about minor details.
- DanSmooth 8y agoA small "Read the full description"-link to the #readme anchor below the inital short description probably would work wonders here.