Skip to content

Conversation

dimitriedavid
Copy link
Contributor

Description

This PR adds documentation for Yellowstone gRPC:

  • Overview
  • Quickstart
  • API Reference
  • Code examples
  • Best practices

Changes Made

Added a new section for Yellowstone gRPC docs.

Testing

  • [*] I have tested these changes locally
  • [*] I have run the validation scripts (pnpm run validate)
  • [*] I have checked that the documentation builds correctly

@dimitriedavid dimitriedavid requested a review from a team as a code owner October 13, 2025 10:30
@Copilot Copilot AI review requested due to automatic review settings October 13, 2025 10:30
Copy link

github-actions bot commented Oct 13, 2025

🌿 Documentation Preview

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Oct 13, 2025, 1:32 PM

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 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.

@github-actions github-actions bot temporarily deployed to docs-preview October 13, 2025 10:31 Destroyed
@github-actions github-actions bot temporarily deployed to docs-preview October 13, 2025 10:39 Destroyed
@dimitriedavid dimitriedavid requested a review from Copilot October 13, 2025 10:41
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

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]>
@github-actions github-actions bot temporarily deployed to docs-preview October 13, 2025 10:44 Destroyed
@github-actions github-actions bot temporarily deployed to docs-preview October 13, 2025 10:52 Destroyed
Copy link
Contributor

@AlvaroLuken AlvaroLuken left a 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!

@github-actions github-actions bot temporarily deployed to docs-preview October 13, 2025 13:30 Destroyed
@dimitriedavid dimitriedavid merged commit db7f395 into main Oct 13, 2025
8 of 9 checks passed
@dimitriedavid dimitriedavid deleted the dd/yellowstone-grpc branch October 13, 2025 13:37
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