Skip to content

feat: add docs for solana ws and methods#1234

Open
victorbware wants to merge 7 commits intomainfrom
victor/add_solana_ws_docs
Open

feat: add docs for solana ws and methods#1234
victorbware wants to merge 7 commits intomainfrom
victor/add_solana_ws_docs

Conversation

@victorbware
Copy link
Copy Markdown
Collaborator

@victorbware victorbware commented Apr 20, 2026

Description

Adds a dedicated Solana Subscription API section under content/api-reference/websockets/, mirroring the method index from Solana Foundation's PubSub reference. Each page documents one *Subscribe method plus its paired *Unsubscribe call, with wscat and @solana/web3.js examples.

Related Issues

Changes Made

  • Added new directory content/api-reference/websockets/solana-subscription-api-endpoints/ with:
    • solana-subscription-api-endpoints.mdx — category-grouped index page with shared Solana PubSub request/notification format tables.
    • account-subscribe.mdx, program-subscribe.mdx (Accounts).
    • logs-subscribe.mdx, signature-subscribe.mdx (Transactions).
    • root-subscribe.mdx, slot-subscribe.mdx (Cluster).
  • Each method page follows the existing EVM endpoint page template: frontmatter (title/description/subtitle/slug: reference/<kebab-case>), # Supported Networks, # Parameters, # Request with a <CodeGroup> (wscat + @solana/web3.js where available), # Result, and # Unsubscribe.
  • Updated content/api-reference/websockets/subscription-api.mdx:
    • Extended the lead description/subtitle to mention Solana alongside Ethereum, Polygon, Arbitrum, and Optimism.
    • Added a new ## Solana subscription endpoints subsection with per-category tables linking to the 9 new method pages, plus a note that Solana uses native *Subscribe / *Unsubscribe methods (not eth_subscribe).
  • Updated navigation in content/docs.yml: added a new Solana Subscription API Endpoints subsection under the existing WebSockets section (slug solana-subscription-api-endpoints), alongside the existing EVM Subscription API Endpoints.

Testing

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

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

🔗 Preview Mode

Name Status Preview Updated (UTC)
Alchemy Docs ✅ Ready 🔗 Visit Preview Apr 20, 2026, 9:35 AM

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 20, 2026

🔍 Link Check

Status: ❌ Failed

Summary

Status Count
🔍 Total 7910
✅ Successful 6744
⏳ Timeouts 0
🔀 Redirected 397
👻 Excluded 674
❓ Unknown 0
🚫 Errors 94
⛔ Unsupported 1
Broken links (94) — click to expand

Errors per input

Errors in ./content/changelog/2026-03-26.md

Errors in ./content/wallets/pages/authentication/overview.mdx

Errors in ./content/api-reference/op-mainnet/op-mainnet-api-faq/op-mainnet-api-faq.mdx

Errors in ./content/wallets/pages/recipes/upgrade-to-smart-accounts.mdx

Errors in ./content/tutorials/alchemy-university/smart-contract-basics/multi-sig-contracts.mdx

Errors in ./content/wallets/pages/recipes/send-usdc.mdx

Errors in ./content/changelog/2026-04-09.md

Errors in ./content/api-reference/websockets/subscription-api.mdx

Errors in ./content/api-reference/hyperevm/hyperevm-api-overview.mdx

Errors in ./content/api-reference/websockets/solana-subscription-api-endpoints/solana-subscription-api-endpoints.mdx

Errors in ./content/wallets/pages/smart-wallets/quickstart/index.mdx

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

Errors in ./content/changelog/2025-09-18.md

Errors in ./content/changelog/2025-08-28.md

Errors in ./content/api-reference/introduction/api-overview.mdx

Errors in ./content/wallets/pages/recipes/onramp-funds.mdx

Errors in ./content/wallets/pages/index.mdx

Errors in ./content/wallets/pages/recipes/smart-wallets-aave.mdx

Errors in ./content/api-reference/arbitrum-nova/arbitrum-nova-deprecation-notice.mdx

Errors in ./content/api-reference/katana/katana-api-overview.mdx

Errors in ./content/wallets/pages/react-native/getting-started/getting-started-rn-bare.mdx

Errors in ./content/wallets/pages/concepts/smart-account-client.mdx

Errors in ./content/wallets/pages/bundler-api/bundler-faqs.mdx

Errors in ./content/wallets/pages/smart-wallets/how-to-stamp-requests.mdx

Errors in ./content/wallets/pages/react-native/getting-started/getting-started-expo.mdx

View workflow run

@victorbware victorbware marked this pull request as ready for review April 20, 2026 10:10
@victorbware victorbware requested a review from a team as a code owner April 20, 2026 10:10
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1e39020c30

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".


<CodeGroup>
```shell wscat
{"jsonrpc":"2.0","id":1,"method":"accountUnsubscribe","params":[subscription_id]}
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use valid JSON in unsubscribe request examples

The unsubscribe wscat payload is not valid JSON because subscription_id is emitted as an unquoted identifier ("params":[subscription_id]), so users who paste this directly into a WebSocket session will get a parse error instead of unsubscribing. This same pattern appears across the new Solana method pages, so these examples should use an actual numeric ID (for example, 23784) or clearly-marked placeholder JSON that remains syntactically valid.

Useful? React with 👍 / 👎.

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