documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Some improvements to install

Open javabster opened this issue 1 year ago • 2 comments

Using this issue to collect ideas for improving the install page:

  • [x] embed the latest CWQ install video into the page (https://www.youtube.com/watch?v=dZWz4Gs_BuI)
  • [ ] In step 1 - mention other python environments, like anaconda and miniconda
  • [ ] In step 2 - mention that you only need to install pip if you dont use a python environment, otherwise its already installed in the env

javabster avatar Apr 12 '24 13:04 javabster

I think a newcomer could easily be overwhelmed by all the text. I would strip back the steps to the absolute basics and then any extras can be included after. For example the note in step 3. I would either have that after the steps or as something you have to click to open.

I also don't think it is very clear where you put "pip install qiskit." Could add a bit about command prompts if you are using something like Spyder or else for Jupyter / Google Colab, you just run it like you would any other piece of code.

What do you think about including some screengrabs? I think it could make some parts easier to follow.

iheuze avatar Apr 14 '24 20:04 iheuze

I added the video at the top of the page in #1223.

abbycross avatar Apr 24 '24 15:04 abbycross

What do you think about including some screengrabs? I think it could make some parts easier to follow.

Screenshots are tempting because they break up text, but we don't usually include them for several reasons: 1 - they aren't translatable, 2 - they go "stale" frequently 3 - they actually slow down users

beckykd avatar Jul 15 '24 20:07 beckykd