jupyterlite icon indicating copy to clipboard operation
jupyterlite copied to clipboard

The "Build your own JupyterLite" section of the RTD home page links to itself

Open manics opened this issue 3 years ago • 1 comments

Problem

If you go to the JupyterLite RTD home page and scroll down to 🏗️ Build your own JupyterLite 🏗️ you're told to See the [documentation](https://jupyterlite.rtfd.io/) for more details. i.e. it links back to itself. This is because it's a copy of the repository README.

Suggested Improvement

Easy option: Modify the README to link to a relevant page in RTD, e.g. the Quick-Start guide. Hard option: Use separate content for the repository README and the RTD home page.

manics avatar Jul 02 '22 13:07 manics

I was just about to open this same issue ;-)

epugh avatar Aug 11 '22 15:08 epugh

Thanks both for reporting.

Probably the README could be updated to point to a different page, for example: https://jupyterlite.readthedocs.io/en/latest/quickstart/deploy.html

Maybe this could also be a good opportunity to simplify or rework the README a little bit.

jtpio avatar Sep 02 '22 08:09 jtpio