Skip to content

docs: standardize scoped package names across the site and repositories; retain legacy aliases #109

Closed

Description

@firejune

Goal

Use @rig-c/* as the canonical package names across rig-c.org and related repository documentation. Keep short install names as convenience aliases and spine-* names as legacy compatibility entry points. Existing links and installations must keep working.

Naming policy

  • rig-c: the overall project/toolchain brand; also the existing convenience install name for Core.
  • Canonical package identities: @rig-c/core, @rig-c/parts, @rig-c/pose, @rig-c/play, @rig-c/review, and the scoped engine adapters.
  • Prefer a single canonical name in package tables/headings. If both names are useful, put the scoped name first, e.g. @rig-c/core (rig-c).
  • Keep package names distinct from executable names: Core runs as rigc; Parts as rig-parts; Pose already runs as rig-pose when installed through @rig-c/pose.
  • spine-rigc, spine-parts, and spine-html remain published legacy names, not co-equal current product names.

Work

Site

  • Normalize Core's current rig-c / @rig-c/core ordering and package identity across the home toolchain table, Core page, package badges, installation guidance and generated metadata.
  • Use scoped names for new-user package recommendations; explain convenience install names separately without introducing duplicate products.
  • Move spine-* aliases out of primary branding/install recommendations into a clearly labelled legacy-name/compatibility section mapping each old name to its canonical package.
  • Keep Markdown mirrors, llms.txt, llms-full.txt and structured data consistent with the human-facing policy.

Related repository documentation

  • Audit the current READMEs, installation guides, package descriptions and agent-facing documentation in Core, Parts, Pose, Play, Review, Adapters, Getting Started, and other linked rig-c repositories where the same patterns occur.
  • Correct matching current-facing naming inconsistencies in those repositories, not only on the website. Track related PRs here and coordinate repository changes through HQ.
  • For legacy package landing/readme text, clearly point to the canonical name while preserving the old entry point. Record any publication-dependent changes separately rather than claiming the website change updates npm automatically.

Pose convenience package

  • Track rig-pose as the proposed npm convenience package for @rig-c/pose, consistent with rig-parts and rig-play. At the 2026-10-28 check, @rig-c/pose already exposes the rig-pose executable, but the unscoped npm package is absent.
  • Coordinate any alias publication with the Pose repository/release workflow. If added, publish from the same source and version with an automated consistency check. Do not document npm install rig-pose or bunx rig-pose as available before it is actually published and verified. If deferred, leave this dependency explicit.

Compatibility and exclusions

  • No unpublish, deletion of old releases, broken inbound links, or removal of existing CLI names.
  • No blanket replacement inside source imports, dependency manifests, export subpaths, lockfiles or runnable commands. Display canonicalization is not an API migration; verify executable examples separately before changing them.
  • Preserve historical changelogs, captured output, recordings and pinned reproduction instructions with the names/versions that actually produced them.
  • Preserve Spine format support, integration guidance and applicable licensing explanations. Independent branding does not mean removing Spine compatibility.
  • Do not introduce npm deprecation warnings merely to hide old names from primary branding.

Acceptance

  • A new reader sees one canonical scoped identity per package and a clear distinction between package, convenience install name, CLI and legacy name.
  • Current-facing matching patterns in related repository docs are corrected or listed with linked follow-up PRs/issues; historical exceptions are intentional.
  • Existing links/install names and pinned reproductions remain valid.
  • Site build/tests/link verification pass; deployed HTML and machine-readable mirrors agree.
  • Pose alias availability is verified before promotion, or explicitly recorded as pending.

Initial evidence: https://rig-c.org/ , https://rig-c.org/docs/core/ , https://rig-c.org/docs/pose/ .

Activity

  1. firejune commented on Oct 28, 2026

    @firejune
    ContributorAuthor

    HQ: the related-repository audit is done (fixed revisions, read-only). Follow-up docs cards: rig-c/core#1625, rig-c/parts#797, rig-c/play#222, rig-c/pose#457, rig-c/getting-started#30. Historical, pinned, API, licence and private-workspace names are deliberately left as they are. rig-pose is not on npm (404); @rig-c/pose 1.4.0 provides the rig-pose executable — the docs will not recommend the unscoped name until it is published.

  2. firejune commented on Oct 28, 2026

    @firejune
    ContributorAuthor

    HQ 2026-10-29 status: site #110/#111, core #1626/#1629, parts #799, play #223, pose #458, getting-started #31 landed. Last item: the rig-pose convenience alias is wired into pose's release (pose#460/#461); its first publish is the owner's one-time bootstrap in pose's RELEASING.md, after which this closes.

  3. added
    waitingHQ: waiting on another repo
    and removed
    nextHQ: take now
    on Oct 28, 2026
  4. firejune commented on Oct 28, 2026

    @firejune
    ContributorAuthor

    Last item done: rig-pose 1.5.1 is on npm (latest), installs and runs (rig-pose --version 1.5.1, --help exit 0). Its trusted publisher is set (rig-c/pose, release.yml, npm publish allowed; pending validation until the next pose release publishes through it) and publishing access requires 2FA with bypass tokens disallowed. From the next pose release on, the alias publishes automatically beside @rig-c/pose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    featurekind: featurewaitingHQ: waiting on another repo

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions