Skip to content

Conversation

@aashvi0722
Copy link

Related Issue / Discussion:

Fixes Issue #114

Changes:

Please list the central functionalities that have been changed:

  • Modified docs/source/installation.rst to include beginner-friendly context and post-installation verification steps.

Further Details:

Summary:

The current installation documentation is technically accurate but lacks context for new contributors who may not be familiar with virtual environments. Additionally, there was no clear "first-run" guidance to verify a successful setup on Windows.

Before: The guide provided commands for environment setup without explaining their purpose or how to verify the tool was functioning correctly afterward.

After: Added a brief explanation of why venv is recommended and a "What to do after installation" section that guides users to run the sandbox example and check their PYTHONPATH.

Dependencies:

No new dependencies are required for this documentation update.

PR Checklist:

In the context of this PR, I:

@aashvi0722
Copy link
Author

I have opened a PR regarding the installation issue and I’m looking forward to your feedback on these installation fixes. If the PR looks good, please let me know if there are any other small documentation issues I can help with while I wait for the merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant