Skip to content

docs: fix demo instructions in install.md, resolve stale-text review findings#26

Merged
fan-droide merged 1 commit into
mainfrom
docs/codex-text-cleanup
Jun 12, 2026
Merged

docs: fix demo instructions in install.md, resolve stale-text review findings#26
fan-droide merged 1 commit into
mainfrom
docs/codex-text-cleanup

Conversation

@fan-droide

Copy link
Copy Markdown
Collaborator

Resolves the live findings from the earlier Codex text-cleanup review (the AGENTS.md branch finding was already fixed in #25).

Changes

  • docs/install.md — "Running the demo locally" instructed npm run dev, which serves the internal src/ dev pages, not the demo. Corrected to npm run build:component:legacy + npm run demo (the demo loads the built legacy IIFE bundle), with a short note separating the three local servers (demo / dev / docs:dev).
  • docs/build-output.md — added a note that dist/ is gitignored but is exactly what npm ships (files whitelist + prepublishOnly rebuild), to avoid confusion between git status and npm pack --dry-run.
  • agents/claude_codex_workflow_context.md — dated historical banner: the file references the merged webcomponent branch and a nonexistent npm run build script; current workflow lives in AGENTS.md / SESSION_HANDOFF.md.
  • .github/review-prompt.md — deleted: a one-shot review prompt frozen at an old webcomponent HEAD, unreferenced anywhere, no operational value; recoverable from git history.

Validation

  • npm run docs:build passes (validates internal links).
  • grep confirms no remaining references to review-prompt.md or stale npm run build outside the banner explanation.

🤖 Generated with Claude Code

…findings

- install.md "Running the demo locally" told readers to run npm run dev,
  which serves the src/ dev pages, not the demo. Correct flow:
  build:component:legacy + npm run demo, plus a short note separating
  the three local servers (demo / dev / docs:dev).
- build-output.md: note that dist/ is gitignored but is what npm ships
  (files whitelist + prepublishOnly rebuild).
- claude_codex_workflow_context.md: dated historical banner (references
  the merged webcomponent branch and a nonexistent npm run build script).
- Delete .github/review-prompt.md: one-shot review prompt frozen at an
  old webcomponent HEAD, no operational value, unreferenced; recoverable
  from git history.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@fan-droide fan-droide merged commit 1ae9019 into main Jun 12, 2026
2 checks passed
fan-droide added a commit that referenced this pull request Jun 12, 2026
docs: AGENTS.md fixes stranded by PR #26 merge race
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