Skip to content

Windows Git Bash: troubleshooting pelican-quickstart command#3574

Open
tubajavedd wants to merge 2 commits into
getpelican:mainfrom
tubajavedd:windows-bash-doc-update
Open

Windows Git Bash: troubleshooting pelican-quickstart command#3574
tubajavedd wants to merge 2 commits into
getpelican:mainfrom
tubajavedd:windows-bash-doc-update

Conversation

@tubajavedd

Copy link
Copy Markdown

Added documentation for Windows users encountering the bash: pelican-quickstart: command not found error when using Git Bash.

This update explains:

Why the issue occurs (Bash does not automatically recognize Python’s Scripts folder).

Recommended solutions:

Use PowerShell (recommended) instead of Git Bash.

Use WSL (Windows Subsystem for Linux) if a Linux-like environment is desired.

Add Python’s Scripts folder to PATH.

Run Pelican scripts directly via Python as a quickfix.

These instructions will help Windows users successfully run pelican-quickstart and preview their sites without encountering command-not-found errors.

@minchinweb

Copy link
Copy Markdown
Contributor

Sigh... it feels like you took my recommendations and blindly applied them without understanding them or the documentation layout.

  1. Please cross-reference the issue where this came up (so that the conversation can be followed both ways).
  2. To be dropped it at the start of the install page is not the right spot for this. Please review the documentation and now it to a more appropriate spot.
  3. Consider reworking the text; it reads very woodenly right now.

@justinmayer

Copy link
Copy Markdown
Member

Hi @tubajavedd. Both the pull request description as well as the proposed documentation changes feel very much like the output of a large language model (LLM). Did you use an LLM in conjunction with producing this pull request?

@tubajavedd

Copy link
Copy Markdown
Author

Hi @justinmayer, thanks for asking directly.

Yes — I did use an LLM as a supporting tool to help draft and organize the text, but the issue itself, the investigation, and the proposed solutions came from my own debugging and testing on Windows. I take responsibility for the final content and clearly should have spent more time adapting the tone and structure to better match the project’s documentation style.

I understand the concern, and I’ll revise the text to make it more concise, more natural, and better integrated into the existing docs rather than reading like a standalone explanation.

Appreciate you raising this — feedback noted.

@tubajavedd

Copy link
Copy Markdown
Author

Hi @minchinweb, thanks for the direct feedback — I understand your concern.

You’re right that the placement isn’t ideal. I focused too much on solving the immediate Windows issue and didn’t sufficiently consider the overall documentation structure or cross-referencing the original discussion. That’s on me.

I’ll review the docs layout more carefully, move this content to a more appropriate section, and add a clear reference back to the original issue so the context flows both ways. I’ll also rework the wording to be more natural and aligned with the existing documentation style.

Thanks for calling this out — I appreciate the guidance.

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.

3 participants