-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
made explicit that install link is install docs in readme #23905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
I am against this change. I think it is important to make the installation instructions be intelligible without an internet connection. Maybe the change that is needed in to make it clear the rst is the source of the rendered page. |
But if they're installing from source they can find the file in the source, especially since the raw rst is the path to the file. Or they're building the docs locally and then this is the path to the file in the local docs. |
I think it is confusing, if for no other reason than |
We have a top level But yes will compromise and wordsmith to include the path to source. |
I don't really follow the need-source argument. Most users will access README.rst through github because it's the entry page there. They certainly don't need the source information - it's only distracting clutter for them. Which user group would be affected by removing the source? People who have cloned the repo, then go offline, and then want to install from sources. I attribute these people enough expertise to find INSTALL.rst as well. But 🤷 |
04bbedb
to
49e50d8
Compare
was gonna shove it in a footnote, but that only works if there are other footnotes on the page |
ed13a9d
to
ae03362
Compare
made it a little more concise, but put it in a second commit if it's not working. |
Footnote would be a good choice here. The source location is only an addendum. If that does not work, how about
|
So best way to do footnote version is probably by adding a notes section: (as an aside, the research notice should probably not be a subsection of the citation) also squished it down to |
off it Co-authored-by: Thomas A Caswell <tcaswell@gmail.com> Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
479cd75
to
cb16d9e
Compare
Let's not overthink this. |
I think it's confusing to tell people read the install docs or install.rst (I totally didn't even parse that they were the same doc at first) and we link to the docs in other sections of the readme.