Skip to content

[R3][MED] Package READMEs teach internal/nonexistent subpaths; no gate covers package-README surface claims #486

Description

@SisyphusZheng

Source: third full-project audit (2026-07-25). Severity: MEDIUM. Category: new finding.

Evidence

  • packages/app/README.md:22-25 — teaches app authors import { openElement } from '@openelement/adapter-vite/app-vite'; the surface-map (docs/current/PACKAGE_SURFACE.md:50) marks app-vite internal, "not application-authoring surface".
  • packages/create/README.md:7 — references the nonexistent @openelement/app/vite (app exports only ./hono/model/spa/i18n/preact).
  • packages/adapter-vite/README.md:6,22,37 — leads with app-vite and plugin (both internal). All three READMEs carry stale "v0.39 surface" banners.
  • Actual product usage is the adapter-vite root (www/vite.config.ts:1, packages/create/templates/vite.config.ts:1); the root re-exports openElement (packages/adapter-vite/src/index.ts:65).
  • Gate blind spot: tools/check-public-docs-integrity.ts:9-23 and tools/check-version-anchors.ts:48-52 scan only the root READMEs.

Suggested fix

Point all three READMEs at root imports and refresh the banners; mid-term, add package READMEs to a surface-claim gate (compare @openelement/* subpath references against the surface-map).

Activity

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

    cleanupdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions