Updating user documentation

[nickwctan]

Description

This PR is a follow up of my user experience on installing pyenv and poetry for running the VE following the instructions of the documentation we have. I would like to address some inconsistencies and hiccups I faced while following the documentation. Here are my suggestions of ways to improve them. Comments are welcome.

Caveat: All improvements are based on Linux system. There might/might not be any differences for Windows users.

Fixes # (issue)

Type of change

• New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist

• Make sure you've run the pre-commit checks: $ pre-commit run -a
• All tests pass: $ poetry run pytest

Further checks

• Code is commented, particularly in hard-to-understand areas
• Tests added that prove fix is effective or that feature works
• Relevant documentation reviewed and updated

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.03%. Comparing base (e3df427) to head (6344bcb).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #1194   +/-   ##
========================================
  Coverage    95.03%   95.03%           
========================================
  Files           71       71           
  Lines         7276     7276           
========================================
  Hits          6915     6915           
  Misses         361      361           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[davidorme]

@nickwctan Sorry for the slow review. I've overhauled the page to update it to your changes. Mostly, I've moved pyenv to a small section by itself, rather than baking it into the main instructions and script, but I've also rewritten the words. Could you give it a quick read through and let me know if it works and I've caught all the things you noted.

Some points:

• I don't think poetry requires SQLite, so I've dropped that out just to the pyenv section.
• I think technically the python - doesn't need the - but it signifies that the command should take the input from a pipe, so it is canonical for it be there and will help developers see what is going on.

[nickwctan]

LGTM, just have a minor comment on your code.

[nickwctan]

Just not sure what this does?
(test-project-for-test) $

I get an error when running it

[davidorme]

It's not code, it's a message that appears before the command line prompt to show you're in the poetry environment. I'll clarify it.

[davidorme]

It would be helpful if used the right name for a start 😁 should be (virtual-ecosystem)

[nickwctan]

in my terminal, it shows that i am in the env in brackets and then my laptop's name and directory. See below:

(virtual-ecosystem-py3.11) nick@nick-tp:~/SEARRP/virtual_ecosystem$

[davidorme]

Sure but the command prompt is configured by individual users independently of the VE project 😀 I'll put something generic to make it clear

[nickwctan]

Perfect. That's clear to me. Thanks!

If all is good, just need you to approve the changes and we can merge?