Skip to content

Update virtual environment name in documentation from venv to .venv#383

Merged
wu-vincent merged 5 commits intoEndstoneMC:mainfrom
Aevarkan:gitignore-patch
Apr 19, 2026
Merged

Update virtual environment name in documentation from venv to .venv#383
wu-vincent merged 5 commits intoEndstoneMC:mainfrom
Aevarkan:gitignore-patch

Conversation

@Aevarkan
Copy link
Copy Markdown
Contributor

@Aevarkan Aevarkan commented Apr 17, 2026

Note that this updates .gitignore in addition to documentation pages.

This PR changes a few things regarding the documentation for installation:

  • updates the virtual environment's name to .venv from venv to align it with uv's functionality.
  • separate the Windows tab into Command Prompt and PowerShell (see here for the command syntax used)
  • update the .gitignore file to exclude the virtual environment

This is what the updated version looks like:

New version

This is what the old version looks like:

image

@Aevarkan
Copy link
Copy Markdown
Contributor Author

I saw that Tutorials > Install your plugin also had venv:

  • Made another commit 10ab08b that changes it to .venv
  • Also split Windows to Command Prompt and PowerShell to align it with Getting Started > Contributing.
Updated Install your plugin page

Also made 7dc05fe to fix this message that appeared during documentation deployment:

INFO    -  Doc file 'tutorials/install-your-plugin.md' contains an unrecognized relative link '../../getting-started/installation/#environment', it was left as is. Did you mean '../getting-started/installation.md#environment'?

@Aevarkan Aevarkan changed the title Update Getting Started > Installation documentation Update virtual environment name in documentation from venv to .venv Apr 19, 2026
@Aevarkan
Copy link
Copy Markdown
Contributor Author

I did just look at #226. I believe that it'll be fine if there's a divergence there (that PR uses .virtualenvs), as start.sh and autoinstall.sh are used for production, not development.

This PR regards documentation on the manual development side, so I don't believe the scopes overlap.

@wu-vincent wu-vincent merged commit 7a07a52 into EndstoneMC:main Apr 19, 2026
3 checks passed
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (37f8527) to head (7dc05fe).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@     Coverage Diff     @@
##   main   #383   +/-   ##
===========================
===========================

☔ 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.

@Aevarkan Aevarkan deleted the gitignore-patch branch April 20, 2026 02:12
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.

2 participants