-
Notifications
You must be signed in to change notification settings - Fork 6
docs: added yellowstone grpc #764
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
🌿 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 adds comprehensive documentation for Yellowstone gRPC, introducing a new section covering overview, quickstart guide, API reference, code examples, and best practices for streaming Solana blockchain data in real-time.
- Adds complete Yellowstone gRPC documentation section with overview, quickstart, API reference, examples, and best practices
- Creates navigation structure with Getting Started, API Reference, and Resources subsections
- Provides detailed documentation for all subscription types (accounts, transactions, slots, blocks) with filter options and response structures
Reviewed Changes
Copilot reviewed 10 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
File | Description |
---|---|
fern/docs.yml | Adds navigation structure for new Yellowstone gRPC documentation section |
fern/api-reference/yellowstone/overview.mdx | Provides high-level overview of Yellowstone gRPC capabilities and Alchemy enhancements |
fern/api-reference/yellowstone/quickstart.mdx | Contains getting started guide with authentication and basic connection examples |
fern/api-reference/yellowstone/subscribe-request.mdx | Documents the core SubscribeRequest structure and configuration options |
fern/api-reference/yellowstone/subscribe-*.mdx | Detailed API documentation for each subscription type (accounts, transactions, slots, blocks) |
fern/api-reference/yellowstone/examples.mdx | Provides practical Rust code examples for common use cases |
fern/api-reference/yellowstone/best-practices.mdx | Contains production best practices and architectural patterns |
Comments suppressed due to low confidence (1)
fern/api-reference/yellowstone/subscribe-request.mdx:1
- There are multiple TODO comments for Rust examples. These should be completed or removed to avoid confusion in the documentation.
---
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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
Copilot reviewed 10 out of 11 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <[email protected]>
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.
Looks fantastic. 👏 Approved but please look at single linter error before merging!
Description
This PR adds documentation for Yellowstone gRPC:
Changes Made
Added a new section for Yellowstone gRPC docs.
Testing
pnpm run validate
)