Skip to content

Extend release-surface checks to root README npm availability wording #181

@luoyuctl

Description

@luoyuctl

Background

PR #178 added release-surface checks for npm/README.md, but origin/master root README.md still contains npm availability wording while the npm package-channel decision is unresolved. PR #156 improves this copy, but it is still draft + status/needs-human, so the repeatable guard should cover the root README too.

Evidence

User value

Users should not infer that npm is an active or automatically available install path before the package-channel decision is recorded and publication actually happens.

Adoption rationale

Install clarity protects first-run trust. If the root README drifts independently from npm/README.md, users may try an unavailable package path even when the npm wrapper docs are cautious.

Suggested scope

Non-goals

Acceptance criteria

  • Release-surface validation fails when root README.md presents npm as active/available while the package remains unpublished.
  • Existing release/docs checks still pass on the intended current wording.
  • Decide npm package publication path before launch docs go live #174 remains the source of truth for future npm publication decisions.
  • Public docs continue to avoid unavailable active npm install instructions.

Suggested lane

lane/quality

Risk

Low. The main risk is making the check too broad and blocking future authorized npm docs; keep the condition tied to unpublished-state wording and update it when #174 is resolved.

Source

Product release-surface audit on 2026-05-10 after #178 merged.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions