Skip to content

Rewrite docs style guide#1107

Open
SahilAujla wants to merge 7 commits intomainfrom
sa/rewrite-style-guide
Open

Rewrite docs style guide#1107
SahilAujla wants to merge 7 commits intomainfrom
sa/rewrite-style-guide

Conversation

@SahilAujla
Copy link
Collaborator

@SahilAujla SahilAujla commented Mar 6, 2026

Summary

  • replace the rushed style rules with a structured docs style guide
  • add agent-optimized quick rules for AI contributors
  • document changelog conventions and MDX Steps guidance
  • rewrite four representative tutorials as a first-pass eval set

Review these rewritten pages

Questions for review

  • Does the first screen make the page outcome obvious?
  • Are prerequisites explicit without slowing the page down?
  • Do the steps stay focused on actions instead of mixing in too much background?
  • Are the code samples easier to copy, trust, and adapt?
  • Does the tone feel consistent across different doc types?
  • Would you want future rewrites to follow this pattern?

@SahilAujla SahilAujla requested a review from a team as a code owner March 6, 2026 16:18
@github-actions
Copy link

github-actions bot commented Mar 6, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Mar 6, 2026, 5:46 PM

@github-actions
Copy link

github-actions bot commented Mar 6, 2026

🔍 Link Check

Status: ❌ Failed

Summary

Status Count
🔍 Total 6945
✅ Successful 5932
⏳ Timeouts 0
🔀 Redirected 381
👻 Excluded 612
❓ Unknown 0
🚫 Errors 20
⛔ Unsupported 0
Broken links (20) — click to expand

Errors per input

Errors in ./content/wallets/pages/react/add-passkey.mdx

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

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

Errors in ./content/wallets/CONTRIBUTING.md

View workflow run

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