Skip to content

docs: replace legacy rule IDs with slug IDs in examples - #282

Merged
oekazuma merged 1 commit into
mainfrom
docs/fix-legacy-rule-ids
Jul 23, 2026
Merged

oekazuma merged 1 commit into
mainfrom
docs/fix-legacy-rule-ids

Conversation

@oekazuma

@oekazuma oekazuma commented Jul 23, 2026 •

Copy link
Copy Markdown
Owner

Summary

Follow-up to the rule-ID slug migration: 34 spots across 10 en/ja page pairs still showed the pre-migration short IDs (CORRECT006, PERF011, SEO031, …) in suppression-comment examples, config 'off' examples, and cross-references. Since the migration shipped without backward compatibility (intentional), copying those examples silently did nothing.

All 34 are now the current slug IDs — e.g. // svelte-vitals-disable-next-line performance/load-waterfall, 'seo/ssr-disabled': 'off' (slug keys quoted), and prose cross-references like security/handler-state-write in code spans. Every mapping was verified against the actual id: declarations in packages/core/src/rules/; en/ja pairs edited identically.

Verification

  • Repo-wide grep for the legacy ID pattern now returns zero matches in docs
  • astro build green (153 pages); docs-links test green; oxfmt --check clean

Docs-only change — no changeset needed.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated English and Japanese rule documentation to use current rule names in cross-references, suppression comments, and configuration examples.
    • Clarified guidance for browser globals, orphan effects and lifecycles, sequential awaits, load waterfalls, shared server state, and SEO checks.
    • Aligned examples for disabling rules with the current naming convention.

@coderabbitai

coderabbitai Bot commented Jul 23, 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: c7e92225-b452-4c62-83ab-8083cbbb152c

📥 Commits

Reviewing files that changed from the base of the PR and between dab3c6b and 4eb59ec.

📒 Files selected for processing (20)
  • docs/src/content/docs/ja/rules/correctness/instance-browser-global.md
  • docs/src/content/docs/ja/rules/correctness/orphan-effect.md
  • docs/src/content/docs/ja/rules/correctness/orphan-lifecycle.md
  • docs/src/content/docs/ja/rules/performance/load-waterfall.md
  • docs/src/content/docs/ja/rules/performance/minify-disabled.md
  • docs/src/content/docs/ja/rules/performance/sequential-awaits.md
  • docs/src/content/docs/ja/rules/security/server-module-state.md
  • docs/src/content/docs/ja/rules/security/shared-state-import.md
  • docs/src/content/docs/ja/rules/seo/heading-level-skip.md
  • docs/src/content/docs/ja/rules/seo/ssr-disabled.md
  • docs/src/content/docs/rules/correctness/instance-browser-global.md
  • docs/src/content/docs/rules/correctness/orphan-effect.md
  • docs/src/content/docs/rules/correctness/orphan-lifecycle.md
  • docs/src/content/docs/rules/performance/load-waterfall.md
  • docs/src/content/docs/rules/performance/minify-disabled.md
  • docs/src/content/docs/rules/performance/sequential-awaits.md
  • docs/src/content/docs/rules/security/server-module-state.md
  • docs/src/content/docs/rules/security/shared-state-import.md
  • docs/src/content/docs/rules/seo/heading-level-skip.md
  • docs/src/content/docs/rules/seo/ssr-disabled.md

📝 Walkthrough

Walkthrough

Documentation across English and Japanese rule pages replaces legacy numeric identifiers with current rule-path names in cross-references, inline suppression comments, and configuration examples.

Changes

Rule-path documentation migration

Layer / File(s) Summary
Correctness rule references
docs/src/content/docs/{,ja}/rules/correctness/*
Browser-global references and suppression examples now use current correctness rule paths.
Performance rule references
docs/src/content/docs/{,ja}/rules/performance/*
Performance cross-references, suppression comments, and disabling keys now use named rule paths.
Security rule references
docs/src/content/docs/{,ja}/rules/security/*
Security cross-references and intentional-use suppression examples now use named rule paths.
SEO rule references
docs/src/content/docs/{,ja}/rules/seo/*
SEO cross-references and SSR rule disable examples now use named rule paths.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the docs-only replacement of legacy rule IDs with slug IDs in examples.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

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

@oekazuma
oekazuma merged commit dd53f41 into main Jul 23, 2026
7 checks passed
@oekazuma
oekazuma deleted the docs/fix-legacy-rule-ids branch July 23, 2026 01:55
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