docs: add Windows PowerShell setup to quickstart#6
Open
intergalpol-bit wants to merge 1 commit into
Open
Conversation
The quickstart only documented the macOS/Linux flow, so a Windows user gets stuck at venv activation (`source .venv/bin/activate` does not exist on Windows) and has no guidance for resolving the dated `YYYY-MM-DD.json` filenames that later pipeline steps consume as `--input`. Changes: - Add a PowerShell block for venv activation and the `pip install -e ".[dev]"` invocation (quoted extras). - Note that the keyword filename is today's date and add macOS/Linux + PowerShell one-liners to grab the most recent file. Tested on Windows 11 / PowerShell: - `python -m pip install -e ".[dev]"` installs cleanly - `python -m pytest` => 440 passed, 2 skipped - walked config -> discover -> cluster -> score -> generate --dry-run with pipeline/configs/example-saas.yaml, no API keys - `pytest pipeline/tests/test_docs_quickstart.py` still passes after the edit
m0ntydad0n
force-pushed
the
docs/quickstart-windows
branch
from
6aa3545 to
837ac4b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Adds Windows PowerShell instructions to
docs/QUICKSTART_CONTENT_CREATION.md:.\.venv\Scripts\Activate.ps1) andpython -m pip install -e ".[dev]"with quoted extras, alongside the existing macOS/Linux block.YYYY-MM-DD.json), plus macOS/Linux and PowerShell one-liners to grab the most recent file for the--inputof later steps.Why
Following the quickstart on Windows, a user hits two snags the current docs don't cover:
source .venv/bin/activatedoesn't exist on Windows — the reader is stuck at step 1.data/.../YYYY-MM-DD.json, but the real filename is the run date; there's no guidance on resolving it, so chaining discover → cluster → score → generate is guesswork.Doc-only change. No behavior, config, or code touched.
How it was tested
On Windows 11 / PowerShell, in a fresh venv:
python -m pip install -e ".[dev]"— installed cleanly.python -m pytest— 440 passed, 2 skipped.config → discover → cluster → score → generate --dry-runagainstpipeline/configs/example-saas.yamlwith no API keys (28 keywords → 22 clusters → 22 scored → prompt preview).python -m pytest pipeline/tests/test_docs_quickstart.pystill passes after the edit.🤖 Generated with Claude Code