Skip to content

Apply style guide formatting across all docs#1129

Open
SahilAujla wants to merge 3 commits intomainfrom
sa/style-guide-formatting
Open

Apply style guide formatting across all docs#1129
SahilAujla wants to merge 3 commits intomainfrom
sa/style-guide-formatting

Conversation

@SahilAujla
Copy link
Collaborator

@SahilAujla SahilAujla commented Mar 13, 2026

Summary

  • Format 406 files across tutorials, api-reference, wallets, and admin-api to match STYLE_RULES.md and content/wallets/CONTRIBUTING.md
  • Standardize voice, tone, terminology, and heading conventions across all live docs content
  • Update add-evm-chain script templates so future generated pages are style-compliant out of the box

What changed

Voice & tone

  • Use "you" for the reader everywhere; remove "the user", "developers", "users"
  • Wallets docs: remove "Alchemy" per wallets contributing guide

Terminology

  • onchain/offchain (not on-chain/off-chain)
  • API key, JSON-RPC, dApp, WebSocket, ERC-20/721/4337, Alchemy Dashboard
  • Wallets-specific: Smart Wallets (not Account Kit), authentication/owner (not Signer), transactions (not user operations)

Headings

  • Sentence case throughout
  • Replace vague headings (Overview, Introduction, Usage, Details) with descriptive alternatives

Prose

  • Remove filler words: simply, just, easy, basically, in order to
  • Remove promotional language and unnecessary exclamation marks
  • Fix assorted typos found during the pass

Script templates

  • Update src/utils/addEvmChainHelpers.ts quickstart/FAQ/overview templates to follow style guide

Validation

  • pnpm lint — 0 errors (all warnings pre-existing in unrelated files)
  • pnpm lint:broken-links — 0 new broken links (all 26 errors pre-existing)
  • No meaning changes — only formatting, voice, and terminology

Format 406 files to match STYLE_RULES.md and wallets CONTRIBUTING.md:

- Sentence case headings throughout
- Use "you" for the reader, remove "the user"/"developers"/"users"
- Standardize terminology (onchain, offchain, API key, JSON-RPC, dApp,
  WebSocket, ERC-20/721/4337, Alchemy Dashboard, etc.)
- Remove filler words (simply, just, easy, basically, in order to)
- Wallets-specific: remove "we"/"Alchemy", replace Account Kit with
  Smart Wallets, Signer with authentication/owner, user operations
  with transactions
- Fix vague headings (Overview, Introduction, Usage, Details)
- Update add-evm-chain script templates for style compliance
- Fix assorted typos found during formatting pass
@github-actions
Copy link

github-actions bot commented Mar 13, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Mar 14, 2026, 1:04 AM

@github-actions
Copy link

github-actions bot commented Mar 13, 2026

🔍 Link Check

Status: ❌ Failed

Summary

Status Count
🔍 Total 7076
✅ Successful 6011
⏳ Timeouts 1
🔀 Redirected 383
👻 Excluded 655
❓ Unknown 0
🚫 Errors 26
⛔ Unsupported 0
Broken links (26) — click to expand

Errors per input

Errors in ./content/api-reference/stable/stable-api-faq.mdx

Errors in ./content/api-reference/bitcoin/bitcoin-api-overview.mdx

Errors in ./content/api-reference/solana/solana-api-faq.mdx

Errors in ./content/api-reference/zksync/zksync-api-faq.mdx

Errors in ./content/tutorials/getting-started/alchemy-via-libraries.mdx

Errors in ./content/tutorials/build-with-ai/overview.mdx

Errors in ./content/wallets/CONTRIBUTING.md

Errors in ./content/api-reference/pharos/pharos-api-faq.mdx

Errors in ./content/api-reference/trace-api/trace-api-resources/trace-api-vs-debug-api.mdx

Errors in ./content/api-reference/arc/arc-api-faq.mdx

Errors in ./content/api-reference/mythos/mythos-api-faq.mdx

Errors in ./content/tutorials/build-with-ai/alchemy-agent-skills.mdx

Errors in ./content/api-reference/arbitrum/arbitrum-api-faq/arbitrumethereum-differences.mdx

Errors in ./content/api-reference/robinhood-chain/robinhood-chain-api-faq.mdx

Errors in ./content/changelog/2025-09-04.md

View workflow run

@SahilAujla SahilAujla marked this pull request as ready for review March 13, 2026 23:03
@SahilAujla SahilAujla requested a review from a team as a code owner March 13, 2026 23:03
jakehobbs and others added 2 commits March 13, 2026 18:00
Co-Authored-By: Claude <noreply@anthropic.com>
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.

3 participants