Repository navigation
docs: remove residual upstream branding across all Markdown docs - #265
Merged
Merged
Conversation
Drop the remaining Discord invite links from CONTRIBUTING and replace them with in-issue guidance, since the tracker is the only supported channel. Rebrand the coding-agent README in StepCode terms: drop the Discord badge, rename the Pi Packages section to Packages, and document the shipped `step` entrypoint instead of the upstream `pi` binary. Commands documented as `pi install` / `pi update` and the `~/.pi/agent/` package paths do not match what this package ships, so they now read `step` and `~/.stepcode/agent/`. Keep the `pi` manifest key, the `pi-package` keyword, and the `~/.pi/agent/` paths that still apply to plain `pi` invocations, and state that lineage in a new section so the remaining upstream names are not mistaken for leftovers. Replace the two upstream blog links with in-repo references.
Rewrite prose, CLI examples, paths, and extension snippets across all Markdown docs so the product surface reads as `step`. Extension sample factories rename the `ExtensionAPI` factory parameter from `pi` to `step`; the parameter name is caller-chosen and does not affect the contract. Identifiers that the code actually contracts on are deliberately kept: telemetry span and attribute names (`pi.ai.*`, `pi.harness.*`, `pi.session.*`), the `pi` package manifest key and `pi-package` discovery keyword, the published `@step-harness/pi-tui` package, third-party repository names, and the MIT attribution files. Two documentation defects found while verifying claims against source: - `docs/tui-rendering-pipeline.md` §8 documented a table of `PI_*` environment variables that do not exist anywhere in `packages/tui/src`. Replaced with the real entry points: `setIncrementalRenderDisabled()`, the `showHardwareCursor` and `terminal.clearOnShrink` settings, and `resolveEscapeTimeoutMs()`, whose ESC threshold is derived from `SSH_CONNECTION`/`SSH_TTY` with no override. Also corrected the crash log file name (`tui-crash.log`, not `pi-crash.log`), the `write()` path (a plain `process.stdout.write`, with no file side channel), and the `renderDirtyStart` claims. - `docs/step-integration.md` Distribution claimed npm and the standalone archives ship both a `pi` and a `step` executable. Only `step` exists in the `bin` field and in the release output; corrected.
ZouR-Ma
requested review from
MelodyVAR,
Uking-xxx and
liuedcson
as code owners
October 19, 2026 10:40
The `ExtensionAPI` factory parameter name is chosen by the caller, so a documentation sample using `step` compiles and runs. It does not match the codebase, though: `ExtensionFactory` is declared as `(pi: ExtensionAPI)` and all 119 extension examples in `examples/` use `pi`. A reader copying a snippet or cross-referencing an example would see two different names for the same object. Reverts the parameter and its call sites in code samples to `pi`, which is what real code uses, and re-syncs the two `extensions.md` anchors that follow the `pi.appendEntry` / `pi.registerEntryRenderer` headings. Prose and CLI examples keep their `step` naming, since those describe the product rather than mirror source.
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.
Summary
Remove residual upstream branding from Markdown prose, CLI examples, and configuration paths so the product surface matches the shipped
stepexecutable.Examples that mirror actual source keep the source's naming. Extension factory parameters and their API calls remain
(pi: ExtensionAPI)andpi.on(...)/pi.registerTool(...), matching the existing TypeScript examples. The earlier documentation-only rename tostephas been reverted in commit777579f.Intentionally retained
Step Agent Telemetry Schemas: its generator and regression test are updated together, while full generated-document equality remains enforced.pi.ai.*,pi.harness.*, andpi.session.*.pipackage manifest key andpi-packagediscovery keyword.@step-harness/pi-tuipackage name.pi-skills,pi-clm,pi-doom).LICENSE,NOTICE,THIRD_PARTY_NOTICES.md,LICENSE-STATUS.md).Other documentation corrections
docs/tui-rendering-pipeline.md: replace nonexistentPI_*environment switches with actual setters/settings and SSH-derived ESC timeout behavior. Correct the crash log name totui-crash.log, remove the unsupported claim thatwrite()logs to a file, and correct therenderDirtyStartdescription.packages/coding-agent/docs/step-integration.md: correct the distribution section to describe only the shippedstepexecutable (step.exeon Windows), not bothpiandstep.rpc.mdreference to the nonexistent local#message-typesheading.Verification
ExtensionAPIfactory parameter: no mixedpi/stepparameter and call-site naming.packages/agent-corefull test suite after the generated-heading fix: 27 test files passed, 539 tests passed, 1 skipped.check:legacy-scope-prefix,check:public-boundary, andcheck:no-observabilitypassed during the initial documentation pass.Scope
Documentation changes plus the telemetry documentation generator's title and its regression test. No production runtime, build, configuration, or license changes. Unrelated working-tree changes are excluded.