docs: install tutorial PATH co-location + Pi GitHub URL sweep - #604
Merged
Conversation
Two coordinated documentation changes. 1. docs/tutorials/install.md \u2014 PATH setup co-located with install command Option A (Global install) now shows the PATH setup snippets (bash/zsh AND PowerShell) directly under the 'pi install npm:taskplane' command, rather than only in the 'taskplane not on your PATH' troubleshooting section several headings later. A user reading top-to-bottom now hits the complete unified-update recipe at the natural decision point\u2014 install, then 'put pi's bin dir on PATH and pi update is your single source of truth.' The 'taskplane not on PATH' section later in the file still has the three-option troubleshooting menu (npx, direct invocation, PATH addition) for users who reach that section without having read Option A. 2. Pi GitHub URL sweep \u2014 badlogic/pi-mono \u2192 earendil-works/pi Pi's canonical repository is now at https://github.com/earendil-works/pi (per Pi's own package.json: 'repository.url': 'git+https://github.com/earendil-works/pi.git'). Four user-facing docs still pointed at the legacy badlogic/pi-mono location. Sweep update: README.md 2 occurrences CONTRIBUTING.md 1 occurrence docs/specifications/cli/CLI-SPEC.md 1 occurrence docs/tutorials/install.md 1 occurrence All replaced with the canonical https://github.com/earendil-works/pi URL via 'sed -i'. Verified post-change with grep \u2014 zero badlogic/pi-mono references remain in the .md tree. Validation npm run format:check pass
HenryLach
enabled auto-merge
June 17, 2026 21:42
HenryLach
added a commit
that referenced
this pull request
Jun 19, 2026
Move the supervisor stale-ctx fix and the two docs sweeps from
[Unreleased] into a dated [0.30.4] section:
Fixed:
- Supervisor heartbeat timer crashed pi with stale extension ctx (#597)
Docs:
- Pi GitHub URL sweep + install tutorial PATH co-location (#604)
- @mariozechner/* stale-references follow-up sweep (#605)
Insert fresh empty [Unreleased] placeholder per keep-a-changelog
convention.
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
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.
Two coordinated documentation changes.
1.
docs/tutorials/install.md— PATH setup co-located with install commandOption A (Global install) now shows the PATH setup snippets (bash/zsh AND PowerShell) directly under the
pi install npm:taskplanecommand, rather than only in the 'taskplane not on your PATH' troubleshooting section several headings later.A user reading top-to-bottom now hits the complete unified-update recipe at the natural decision point: install, then put pi's bin dir on PATH, and
pi updateis your single source of truth.The 'taskplane not on PATH' section later in the file still has the three-option troubleshooting menu (npx, direct invocation, PATH addition) for users who reach that section without having read Option A.
2. Pi GitHub URL sweep —
badlogic/pi-mono→earendil-works/piPi's canonical repository is now at
https://github.com/earendil-works/piper Pi's ownpackage.json:Four user-facing docs still pointed at the legacy
badlogic/pi-monolocation. Sweep update:README.mdCONTRIBUTING.mddocs/specifications/cli/CLI-SPEC.mddocs/tutorials/install.mdAll five replaced with the canonical
https://github.com/earendil-works/piURL. Verified post-change: zerobadlogic/pi-monoreferences remain in the.mdtree.Out of scope (noticed during sweep)
There are still several
@mariozechner/*package-name references in maintainer and specification docs:docs/maintainers/development-setup.md(loader mock docs)docs/maintainers/testing.md(loader mock docs)docs/specifications/cli/CLI-SPEC.md(peerDeps example)docs/specifications/framework/33-parallel-task-orchestrator.md(3xnpm install -g @mariozechner/pi-coding-agent)docs/specifications/taskplane/code-quality-gates.md(already self-aware about staleness; flagged 'TP-191 will refresh')docs/specifications/taskplane/migrate-to-node-test-runner.md(test alias docs)These are about the npm package scope (Pi was renamed from
@mariozechner/pi-coding-agentto@earendil-works/pi-coding-agentat Pi v0.74.0), distinct from the GitHub URL change this PR addresses. Some are accurately documenting back-compat for legacy scopes (the test loader DOES need to recognize both for tests to run against historical Pi versions), others are stale. Worth a follow-up cleanup pass; not in scope for this PR per your request scope.Validation
npm run format:checkgrep -rn 'badlogic/pi-mono' --include='*.md' .No code changes, no release needed.