Skip to content

Improve installation and quick start documentation for beginner onboarding. #114

@shikhasharma-passion

Description

@shikhasharma-passion

Description:
While going through the installation documentation as a new contributor, I noticed that the steps are technically correct but assume prior knowledge (for example, familiarity with virtual environments).

Additionally, after completing the installation, there is no clear guidance on what users should do next to verify or start using the tool.

Suggestion:

  • Briefly explain what a virtual environment is and why it is recommended
  • Add a short "What to do after installation" section
  • Optionally include a minimal first-run example or reference.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions