Skip to content

docs: sweep retired vocabulary and stale references - #413

Merged
oekazuma merged 2 commits into
mainfrom
chore/staleness-sweep
Aug 8, 2026
Merged

oekazuma merged 2 commits into
mainfrom
chore/staleness-sweep

Conversation

@oekazuma

@oekazuma oekazuma commented Aug 8, 2026 •

Copy link
Copy Markdown
Owner

From the 2026-08-08 audit (the staleness cluster). Nine small, verified fixes in one cohesive PR — every location was checked against live code before editing:

  1. AGENTS.md: docs is a Blume site (docs/blume.config.ts), not "Astro Starlight"; packages/vite ships the "live dashboard", not the retired "dev overlay". Agents read this file every session — it was teaching retired vocabulary.
  2. CONTRIBUTING.md: same Blume fix + the # astro check comment is now # blume check.
  3. "dev overlay" naming sweep (retired 2026-07-12): 6 comment/doc sites across bin.ts, both version.ts files, hooks/handle.ts, and the en/ja configuration guides now say "live dashboard" (ja: ライブダッシュボード, matching the dev-dashboard guide). The design-doc filename citation in plugin.ts stays, as it should.
  4. ci.yml: the floor-smoke comment named pnpm@11.17.0 (two bumps stale) — now version-free ("the pinned pnpm in the root package.json") so it can't rot again.
  5. rule.ts: the Scope doc comment omitted 'component' — the variant most new rules use.
  6. Generated skill headers (skill-content.ts + improve-skill-content.ts): "Re-run with --force to refresh" → "Re-run svelte-vitals install --refresh to regenerate" — --force re-enters the wizard; --refresh is the purpose-built command. No tests pinned the old string (verified).
  7. npm registry descriptions (the one registry-visible change, with a patch changeset for both packages): svelte-vitals still sold itself as an SEO-only head-metadata checker — now matches its own --help one-liner (five categories), plus performance/security/code-quality/static-analysis keywords; @svelte-vitals/vite now mentions the live dashboard.
  8. AGENTS.md design-docs paragraph: records where the --fix decision lives (issue feat: --fix autofix (robots.txt / sitemap.xml / canonical) #11, closed as agent-delegated, in the 2026-06-22 MCP design doc) — previously discoverable only inside a doc for a deleted feature.

Verification

pnpm -r typecheck / pnpm test (core 1321, cli 863, vite 213) / pnpm lint / pnpm -r build / pnpm check:publish all green. grep confirms zero remaining Starlight / dev overlay hits outside design-doc history.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation

    • Clarified that the Vite/SvelteKit integration includes a live development dashboard alongside build-time analysis.
    • Updated guidance for configuration overrides and the supported installation refresh command.
    • Expanded rule scope documentation to include component-level evaluation.
  • Chores

    • Refined package descriptions and keywords to better reflect code-health scanning, security, performance, and static analysis capabilities.
    • Updated project guidance and release metadata for accuracy.

…l header

Follow-up to the staleness sweep: improve-skill-content.ts carried the same
"Re-run with --force to refresh." sentence as skill-content.ts, generated
side by side in a user's repo. Aligns both to `install --refresh`.
@coderabbitai

coderabbitai Bot commented Aug 8, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 09e4f8ce-bc22-4c32-bb35-3f79f61434e9

📥 Commits

Reviewing files that changed from the base of the PR and between 8e8bd5c and da3a11e.

📒 Files selected for processing (15)
  • .changeset/stale-npm-descriptions.md
  • .github/workflows/ci.yml
  • AGENTS.md
  • CONTRIBUTING.md
  • docs/src/content/docs/guides/(setup)/configuration.mdx
  • docs/src/content/docs/ja/guides/(setup)/configuration.mdx
  • packages/cli/package.json
  • packages/cli/src/bin.ts
  • packages/cli/src/install/improve-skill-content.ts
  • packages/cli/src/install/skill-content.ts
  • packages/cli/src/version.ts
  • packages/core/src/rule.ts
  • packages/vite/package.json
  • packages/vite/src/hooks/handle.ts
  • packages/vite/src/version.ts

📝 Walkthrough

Walkthrough

The pull request updates package metadata, release descriptions, documentation, comments, and repository guidance. The text now reflects the live dashboard, Blume, broader code-health scanning, current CLI commands, and component-scoped rules.

Changes

Documentation and metadata alignment

Layer / File(s) Summary
Package identity and release metadata
.changeset/..., packages/cli/package.json, packages/vite/package.json
Package descriptions and patch-release metadata now describe broader code-health scanning and the Vite live dashboard.
Live dashboard references
packages/cli/src/bin.ts, packages/cli/src/version.ts, packages/vite/src/hooks/handle.ts, packages/vite/src/version.ts
CLI and Vite comments now reference the live dashboard, its ingest endpoint, and its version display.
Configuration and rule-scope documentation
docs/src/content/docs/guides/(setup)/configuration.mdx, docs/src/content/docs/ja/guides/(setup)/configuration.mdx, packages/core/src/rule.ts
Documentation identifies the dashboard request layer and documents component-scoped rule evaluation.
Repository and CLI guidance
AGENTS.md, CONTRIBUTING.md, .github/workflows/ci.yml, packages/cli/src/install/*
Guidance now reflects Blume, current design decisions, the root pnpm pin, and the --refresh command.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the primary changes: replacing retired terminology and updating stale references across documentation, comments, and package metadata.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
📝 Generate docstrings 💡
  • Create stacked PR
  • Commit on current branch

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@oekazuma
oekazuma merged commit f0798b0 into main Aug 8, 2026
8 checks passed
@oekazuma
oekazuma deleted the chore/staleness-sweep branch August 8, 2026 10:40
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