[docs-agent] Weekly style audit fixes 2026-06-17#1392
Open
alchemy-bot wants to merge 1 commit into
Open
Conversation
Fix `JSON RPC` → `JSON-RPC` in polygon-zkevm/ethereum differences page (2 occurrences in same file). The file uses the correct `JSON-RPC` form on lines 8 and 24; the H2 heading on line 10 and the prose on line 12 had drifted to the no-hyphen form. Per STYLE_RULES.md's preferred terminology table, `JSON-RPC` is the canonical spelling.
🔗 Preview Mode
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Weekly audit fixes for ERROR-level style violations found in PRs merged this week (2026-06-10 → 2026-06-17).
Files fixed
content/api-reference/polygon-zkevm/polygon-zkevm-api-faq/polygon-zkevm-and-ethereum-differences.mdx## JSON RPC Method Differences→## JSON-RPC Method DifferencesThe following JSON RPC methods…→The following JSON-RPC methods…JSON RPC(missing hyphen) appears twice in the same file. The file already uses the correctJSON-RPCform on lines 8 and 24, so this is internal-inconsistency drift, not intentional convention. PerSTYLE_RULES.md's preferred-terminology table (JSON-RPCpreferred;JSONRPC,json-rpcavoided), the hyphenated form is canonical. Two occurrences in the same file meets the audit playbook's ERROR threshold ("wrong terminology repeated in multiple places within the same file"). The file was touched this week by #1387 (slug refactor), so it's in scope.Only the hyphen was added. Title case on the H2 was preserved per past audit precedent on legacy template-style headings (single change per finding).
Scope
Audit covered 20 PRs merged 2026-06-10 → 2026-06-17 across 10 manually-authored MDX files in
content/. Auto-generated content (Daikon chain overview pages from #1377 and weekly changelog #1379) was out of scope per the playbook.Only the ERROR-level violation above was fixed in this PR. Warning-level items noted below for visibility, not PR'd per the playbook.
Warning-level items (not fixed)
content/api-reference/sonic/sonic-blaze-deprecation-notice.mdx:17— bareDashboard("Endpoints page in the Dashboard") while line 28 correctly usesAlchemy Dashboard. Single instance — WARNING per playbook.content/api-reference/katana/katana-api-quickstart.mdx:76,95— code sample placeholder isyour-api-keyinstead of{apiKey}. Intentional choice in docs(katana): add Katana API quickstart and FAQ guides #1386 (per PR rationale, avoids the unbalanced${…}template syntax issue from the Kaia PR). Pre-existing convention across similar quickstarts.content/api-reference/katana/katana-api-quickstart.mdx— uses manually-numbered### 1./### 2./### 3./### 4.headings instead of the preferredSteps/Stepcomponents. Existing pattern in many quickstart pages; cross-file normalization belongs in a separate sweep.content/api-reference/sonic/sonic-api-quickstart.mdx:96—# Sonic APIsH1 inside body (skips heading levels). Pre-existing, matches index/overview template pattern.content/api-reference/sonic/sonic-blaze-deprecation-notice.mdx:7—## ⚠️ Deprecation NoticeTitle Case heading. Matches the established deprecation-notice template convention per prior audit precedent.content/api-reference/polygon-zkevm/polygon-zkevm-api-faq/polygon-zkevm-and-ethereum-differences.mdx— Title Case section headings (## Opcodes,## Additions,## Other Minor Differences) and vague## Additionsheading. Legacy FAQ page; cross-file normalization belongs in a separate sweep.content/api-reference/polygon-zkevm/polygon-zkevm-api-faq/polygon-zkevm-and-ethereum-differences.mdx:38— typozKEVM(lowercasek, single instance). WARNING.content/api-reference/katana/katana-api-faq.mdx:9— "yield back to users and applications" describes Katana network end-users (not the docs reader), so the avoid-usersrule doesn't strictly apply. Borderline.Autogenerated content (out of scope): the 70
<chain>-api-overview.mdxfiles from Daikon PR #1377, plus the weekly changelog atcontent/changelog/2026-06-11.md(#1379).