Skip to content

docs: install tutorial PATH co-location + Pi GitHub URL sweep - #604

Merged
HenryLach merged 1 commit into
mainfrom
docs/pi-repo-sweep-and-install-tutorial-path
Jun 17, 2026
Merged

docs: install tutorial PATH co-location + Pi GitHub URL sweep#604
HenryLach merged 1 commit into
mainfrom
docs/pi-repo-sweep-and-install-tutorial-path

Conversation

@HenryLach

Copy link
Copy Markdown
Owner

Two coordinated documentation changes.

1. docs/tutorials/install.md — 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: 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 — badlogic/pi-monoearendil-works/pi

Pi's canonical repository is now at https://github.com/earendil-works/pi per Pi's own package.json:

"repository": {
  "type": "git",
  "url": "git+https://github.com/earendil-works/pi.git"
}

Four user-facing docs still pointed at the legacy badlogic/pi-mono location. Sweep update:

File Refs updated
README.md 2
CONTRIBUTING.md 1
docs/specifications/cli/CLI-SPEC.md 1
docs/tutorials/install.md 1

All five replaced with the canonical https://github.com/earendil-works/pi URL. Verified post-change: zero badlogic/pi-mono references remain in the .md tree.

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 (3x npm 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-agent to @earendil-works/pi-coding-agent at 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

Gate Result
npm run format:check ✅ pass
grep -rn 'badlogic/pi-mono' --include='*.md' . ✅ no matches
Install tutorial Option A reads coherently top-to-bottom ✅ visually verified

No code changes, no release needed.

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
HenryLach enabled auto-merge June 17, 2026 21:42
@HenryLach
HenryLach merged commit bb0af0a into main Jun 17, 2026
1 check passed
@HenryLach
HenryLach deleted the docs/pi-repo-sweep-and-install-tutorial-path branch 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.
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