Re:Ask HN: Thoughts on new GitHub layout?
by JoshTriplett on Tuesday June 23, 2020 @06:14PM
(#23621035)
That seems like a tradeoff between people discovering a project and people developing that project. People initially discovering a project usually want the README; people developing a project may potentially want either.
[ Parent
| on HN ]
I never look at the Code page of projects I work on. I'm always going straight to the pull requests or issues.
I always thought the Code page's intended audience was new people checking out the repo for documentation or to peruse the code (usually after checking out the README).
Re:Ask HN: Thoughts on new GitHub layout?
by JoshTriplett on Wednesday June 24, 2020 @02:11AM
(#23624654)
I find that the code helps me get oriented, like running ls in a project's directory after cd-ing to it.
That is true, I don't really know what the answer is. You could do something like show half code/half readme, with extra code hidden behind a fold.. but I'm sure that would annoy devs working on those additional hidden files.
Re:Ask HN: Thoughts on new GitHub layout?
by JoshTriplett on Tuesday June 23, 2020 @07:25PM
(#23621721)
I'd be happy with a README-first design that had a link to move the README below the code, and that remembered which one you want on top for each repository. (Along with a preference for logged-in users to decide what they want.)
Re:Ask HN: Thoughts on new GitHub layout?
by eeereerews on Tuesday June 23, 2020 @09:11PM
(#23622729)
You can also put a Readme in any folder and it will show up the same way. You usually wouldn't want those up top while browsing the files though. So it's also about consistency.