Improve the documentation landing page

[pradyunsg]

pip's current documentation and README are not very good. They lack any form of good description about pip. It would probably help to provide "what pip is for and is not for" in this page perhaps.

/cc @theacodes @ncoghlan #4758 (comment)

---

What reminded me about this -- the recent changes/improvements to the following:

• https://twine.readthedocs.io/en/latest/#twine-user-documentation
• https://docs.python.org/3/library/asyncio.html

[pradyunsg]

I think it might be useful to include the README.rst file into docs/html/index.rst files, before the toctree of the documentation (it's technically possible; the concern is more content oriented).

It'll ensure a single point of truth for both the locations, which is a good thing.

[pradyunsg]

@pfmoore @theacodes @ncoghlan Ping!

Thoughts/Inputs on this?

[theacodes]

I have lots of thoughts. :) Maybe I'll try to find some free time and write up a new README & Index for pip.

[lock]

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.