[docs-agent] Weekly style audit fixes 2026-07-29 - #1486
Open
alchemy-bot wants to merge 1 commit into
Open
Conversation
Hyphenate ERC-20 / ERC-721 / ERC-1155 in address-activity-webhook.mdx prose to match STYLE_RULES.md preferred terminology. Also add a missing space between the backticked `token` and `maps` in the category field description. Literal API enum values in backticks (`erc721`, `erc1155`, `erc20`) are preserved. Scope: address-activity-webhook.mdx was modified in this week's PR #1443 and had 9 prose instances of ERC20/ERC721/ERC1155 (per-file repeat, ERROR-level per playbook).
🔗 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.
Files fixed
content/api-reference/data/webhooks/webhook-types/address-activity-webhook.mdx— hyphenateERC20/ERC721/ERC1155toERC-20/ERC-721/ERC-1155in prose (9 instances across the intro paragraph, the transfer-type table, and the field-descriptions table). Also fix a missing space between the backticked`token`andmapsin thecategoryfield description.Literal API enum values in backticks (
`erc721`,`erc1155`,`erc20`) are preserved because those match the actualcategoryfield values the webhook emits.Scope
Only ERROR-level terminology fixes on a live docs page whose file was modified in this week's merged set. Warning-level and style-preference issues were noted but skipped per the audit playbook.
Warning-level findings (not fixed — flagged for reference)
content/changelog/2026-07-23.mdline 6: single-instanceon-chain state— single instance in a changelog bullet, stays WARNING per playbook.content/api-reference/alchemy-transact/transaction-simulation/*.mdx(six deprecated pages, deprecation date 2026-09-30): repeatedERC20/ERC721in prose andAlchemy API Keyin code comments. Skipped because the pages carry a deprecation notice — fixing terminology on soon-to-be-removed content adds churn.content/api-reference/data/webhooks/webhook-types/address-activity-webhook.mdxlines 40, 124, 173, 179: Title Case section headings (# Example Response,# Field Definitions,# Useful Endpoints,# How to Set-Up Address Activity Webhook). Match the existing legacycontent/api-reference/index-page pattern — WARNING per prior weekly-audit LEARNINGS, not fixed unilaterally on a single page.content/api-reference/data/webhooks/webhook-types/address-activity-webhook.mdxline 151: lowercaseerc721without backticks in prose — ambiguous between literal enum value (needs backticks) and prose (needs hyphen). Left alone.