Skip to content

Conversation

Richard-Dang
Copy link
Contributor

@Richard-Dang Richard-Dang commented Aug 27, 2025

Pull Request Checklist


PR-Codex overview

This PR focuses on updating documentation guidelines for Alchemy's Smart Wallets, enhancing clarity, consistency, and compliance with style standards. It includes changes to local documentation commands, terminology enforcement, and the introduction of a structured review process.

Detailed summary

  • Removed .github/instructions/docs.instructions.md and docs/rules/docs-contribution-guidelines.md.
  • Updated local commands in CONTRIBUTING.md to yarn docs:dev and yarn fern:gen.
  • Introduced a detailed docs-reviewer.instructions.md for systematic documentation review.
  • Enhanced terminology enforcement with specific prohibited terms and replacements.
  • Added structured validation process for voice, tone, and code standards in documentation.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Copy link

vercel bot commented Aug 27, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
aa-sdk-ui-demo Ready Ready Preview Comment Aug 27, 2025 8:04pm

Copy link
Contributor

graphite-app bot commented Aug 27, 2025

How to use the Graphite Merge Queue

Add the label graphite-merge-queue to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

@Richard-Dang Richard-Dang requested a review from Copilot August 27, 2025 19:47
Copy link

github-actions bot commented Aug 27, 2025

🌿 Documentation Preview

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Aug 27, 2025, 7:57 PM

@github-actions github-actions bot temporarily deployed to docs-preview August 27, 2025 19:48 Inactive
Copilot

This comment was marked as outdated.

@github-actions github-actions bot temporarily deployed to docs-preview August 27, 2025 19:55 Inactive
@Richard-Dang Richard-Dang requested a review from Copilot August 27, 2025 19:56
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR establishes comprehensive documentation guidelines for Alchemy's Smart Wallets product, consolidating and replacing existing scattered documentation rules with a unified, structured approach. The changes focus on standardizing terminology, enforcing consistent voice and tone, and providing systematic review processes.

Key changes include:

  • Created a comprehensive documentation style guide with strict terminology enforcement and voice requirements
  • Established a systematic review process with prioritized validation criteria
  • Updated local development commands to align with current tooling

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/CONTRIBUTING.md Comprehensive new style guide with terminology standards, voice requirements, and quality assurance checklists
docs/rules/docs-reviewer.mdc Systematic documentation reviewer instructions with prioritized validation criteria and feedback templates
docs/rules/docs-contribution-guidelines.mdc Removed old guidelines file in favor of consolidated approach
CONTRIBUTING.md Updated local documentation commands and referenced new comprehensive guidelines
.github/instructions/docs.instructions.md Removed old GitHub instruction file
.github/instructions/docs-reviewer.instructions.md New GitHub-specific reviewer instructions mirroring the main reviewer guide

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions github-actions bot temporarily deployed to docs-preview August 27, 2025 19:56 Inactive
@github-actions github-actions bot temporarily deployed to docs-preview August 27, 2025 19:56 Inactive
- `UserOperation` instead of UserOperation during first occurrence of it in a doc, then UO for subsequent occurrences.
- To run docs locally: `yarn docs:dev`.
- To build docs: `yarn fern:gen`.
- When editing or adding new docs, make sure you follow the [docs contributing guidelines](docs/CONTRIBUTING.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙌

@Richard-Dang Richard-Dang merged commit 4714a52 into main Aug 27, 2025
11 checks passed
@Richard-Dang Richard-Dang deleted the richard/contributions branch August 27, 2025 20:53
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.

2 participants