Skip to content

[Styler] Weekly style audit fixes (2026-09-22) - #1645

Open
JackReacher0807 wants to merge 1 commit into
mainfrom
docs/styler/weekly-style-audit-2026-09-22
Open

JackReacher0807 wants to merge 1 commit into
mainfrom
docs/styler/weekly-style-audit-2026-09-22

Conversation

@JackReacher0807

Copy link
Copy Markdown
Collaborator

Weekly style audit against files changed by PRs merged in the last 7 days. All findings below are ERROR-level per STYLE_RULES.md — mechanical fixes only. WARNING-level issues (formatting whitespace, single-instance typos in older files) were skipped per Mode 4 guidance.

Fixes

content/api-reference/solana/solana-api-overview.mdx (from #1641, #1639, #1629, #1623)

  • Rule: Factual accuracy in API reference
  • Found: `getBalanceByOwnerAtSlot` was listed twice in the same row of the methods table (both cells identical).
  • Fix: Removed the duplicate cell and re-flowed the two-column table so each row remains balanced. All 60 unique methods preserved.

content/api-reference/arc/arc-api-faq.mdx (from #1622)

  • Rule: Grammar / factual correctness in headings
  • Found: `## What is a Arc API key?`
  • Fix: `## What is an Arc API key?`

content/api-reference/data/webhooks/webhook-types/address-activity-webhook.mdx (from #1630)

  • Rule: Preferred terminology (STYLE_RULES §Terminology and naming)
  • Found: `ERC20`, `ERC721`, `ERC1155` in prose and a table row.
  • Fix: `ERC-20`, `ERC-721`, `ERC-1155`.

content/api-reference/introduction/api-overview.mdx (from #1636)

  • Rule: Sentence case headings (STYLE_RULES §Voice and tone / §Write headings that help people scan)
  • Found: `title: Choose Your Starting Point`
  • Fix: `title: Choose your starting point`

Not fixed (flagged for human/writer)

  • `arc-api-quickstart.mdx`: uses "familiar to developers who have worked with…" — mild "developer" reference; leaving for a Writer pass on the full quickstart section.
  • `address-activity-webhook.mdx`: uses h1 (`# Introduction`, `# Example Response`, `# How to Set-Up Address Activity Webhook`) inside the page body instead of h2, and `Set-Up` should be `set up`. Pre-existing structural issue not introduced this week; needs a broader cleanup PR.
  • `giwa-api-overview.mdx`, `solana-api-overview.mdx`, `arc-api-faq.mdx`, others: page titles use Title Case (`Giwa API Overview`, `Arc API FAQ`). This is the existing repo pattern across every `-api-overview.mdx` / `-api-faq.mdx` — worth a coordinated rename, not a one-off in this PR.

Verification

  • `pnpm run lint` → 0 errors, 38 pre-existing warnings unrelated to these changes.
  • No code samples modified.

- solana-api-overview.mdx: remove duplicate getBalanceByOwnerAtSlot row and re-flow methods table
- arc-api-faq.mdx: fix grammar (a Arc -> an Arc)
- address-activity-webhook.mdx: use preferred ERC-20 / ERC-721 / ERC-1155 terminology
- introduction/api-overview.mdx: sentence case title (Choose your starting point)
@JackReacher0807
JackReacher0807 requested a review from a team as a code owner September 23, 2026 01:19
@github-actions

github-actions Bot commented Sep 23, 2026

Copy link
Copy Markdown

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Sep 23, 2026, 1:20 AM

This branch has not been deployed

No deployments
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