creativecommons.github.io-source icon indicating copy to clipboard operation
creativecommons.github.io-source copied to clipboard

[Bug] The documentation is missing important commands and specific steps needed to run the necessary commands correctly.

Open Dev-JoyA opened this issue 4 months ago • 3 comments

Description

The documentation states that a Python environment must be created, but it lacks specific commands to guide users through this process. This absence of information can impede the development workflow, as users may struggle to set up their environment correctly.

Additionally, if Python 3.11 is not installed on a user's system (or if pipenv is unable to locate it), they might need to specify the Python path. However, the documentation does not currently address the necessary steps or alternatives if Python 3.11 is present instead.

Reproduction

  1. Open the open source repository.
  2. Go to the README file , find the Installing Project Requirements sub heading.
  3. There is a requirement to create python virtual environment, but the command is missing.

Expectation

I expected the documentation to provide clear and detailed commands for creating a Python environment, ensuring users could easily set it up. This clarity would help prevent confusion and ensure a smooth development process, allowing all team members to quickly get started with the project without facing setup issues.

Resolution

  • [x] I would be interested in resolving this bug.

Dev-JoyA avatar Oct 06 '24 05:10 Dev-JoyA