-
Notifications
You must be signed in to change notification settings - Fork 197
chore: update contributing.md #1956
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
How to use the Graphite Merge QueueAdd 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. |
🌿 Documentation Preview
|
There was a problem hiding this 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.
- `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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙌
Pull Request Checklist
yarn test
)site
folder, and guidelines for updating/adding docs can be found in the contribution guide)feat!: breaking change
)yarn lint:check
) and fix any issues? (yarn lint:write
)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
.github/instructions/docs.instructions.md
anddocs/rules/docs-contribution-guidelines.md
.CONTRIBUTING.md
toyarn docs:dev
andyarn fern:gen
.docs-reviewer.instructions.md
for systematic documentation review.