[Docs] Add installation instructions to documentation

Question

[Docs] Add installation instructions to documentation

JeppeKlitgaard opened this issue 2 years ago · comments

Currently the installation instructions are only found in the GitHub README. Since installation is more involved than simply pip install jax, I think it would be really nice to copy/move over the installation instructions to the documentation, perhaps a subsection titled "Installation" under "Getting Started"?

Jake Vanderplas · Answer 1 · Sat Apr 23 2022 00:30:22 GMT+0800 (China Standard Time)

Thanks for the request.

We've discussed this previously and the consensus at the time was that (1) we want installation instructions in the README because that's a common landing page for people, and (2) we don't want to maintain two separate copies of the installation instructions.

The result was the current state of things, where the installation instructions are only in the README.

Jeppe Klitgaard · Answer 2 · Sat Apr 23 2022 02:15:53 GMT+0800 (China Standard Time)

That makes a lot of sense. Feel free to close this issue – it might be worthwhile to add a link to the GitHub README from documentation?

Jake Vanderplas · Answer 3 · Sat Apr 23 2022 03:36:22 GMT+0800 (China Standard Time)

Thanks for the suggestion - Done in #10423