docs(injective): apply spec feedback to PR #1235#1241
Open
JackReacher0807 wants to merge 1 commit intomainfrom
Open
docs(injective): apply spec feedback to PR #1235#1241JackReacher0807 wants to merge 1 commit intomainfrom
JackReacher0807 wants to merge 1 commit intomainfrom
Conversation
Follow-up to @andra-catana's #1235 addressing @daniel's review feedback. 1. Revert chain-level description expansion. The docs site does not consume info.description or per-server descriptions from chain OpenRPC specs — those don't surface on method reference pages. info.description is back to the canonical minimal form and server entries carry only url and name, matching every other chain spec. 2. Pull debug_* methods out of the chain spec. Debug namespace methods live in the dedicated Debug API product spec, not in chain specs. No debug_* refs exist in src/openrpc/chains/injective/injective.yaml and no debug_* method definitions exist in src/openrpc/chains/_components/injective/methods.yaml. 3. Move the useful network-coverage prose onto the individual method pages where it renders. src/openrpc/chains/_components/injective/methods.yaml overrides three methods (eth_getBlockReceipts, eth_syncing, net_listening) with an Injective-specific description callout noting testnet-only availability. The chain spec refs are updated to point at those overrides. 4. Inline Debug method tables removed from injective-api-overview.mdx and replaced with a short paragraph linking to /docs/reference/debug-api-quickstart and /docs/reference/debug-api-endpoints. injective-api-faq.mdx and injective-api-quickstart.mdx now mention that debug_* lives in the Debug API. Verified: pnpm run validate:rpc ✅, pnpm run generate:rpc ✅, pnpm run lint ✅ (prettier warnings in two unrelated files, not touched here). Co-authored-by: andra.catana <andra.catana@alchemy.com>
🔗 Preview Mode
|
🔍 Link CheckStatus: ❌ Failed Summary
Broken links (80) — click to expandErrors per inputErrors in ./content/api-reference/op-mainnet/op-mainnet-api-faq/op-mainnet-api-faq.mdx
Errors in ./content/api-reference/arbitrum-nova/arbitrum-nova-deprecation-notice.mdx
Errors in ./content/wallets/pages/authentication/overview.mdx
Errors in ./content/wallets/pages/recipes/onramp-funds.mdx
Errors in ./content/api-reference/arbitrum/arbitrum-api-faq/arbitrum-api-faq.mdx
Errors in ./content/wallets/pages/bundler-api/bundler-faqs.mdx
Errors in ./content/changelog/2025-09-18.md
Errors in ./content/tutorials/alchemy-university/smart-contract-basics/multi-sig-contracts.mdx
Errors in ./content/api-reference/introduction/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/changelog/2026-04-09.md
Errors in ./content/changelog/2026-03-26.md
Errors in ./content/wallets/pages/react-native/getting-started/getting-started-expo.mdx
Errors in ./content/wallets/pages/recipes/smart-wallets-aave.mdx
Errors in ./content/api-reference/hyperevm/hyperevm-api-overview.mdx
Errors in ./content/api-reference/katana/katana-api-overview.mdx
Errors in ./content/wallets/pages/recipes/send-usdc.mdx
Errors in ./content/wallets/pages/recipes/upgrade-to-smart-accounts.mdx
Errors in ./content/wallets/pages/smart-wallets/how-to-stamp-requests.mdx
Errors in ./content/wallets/pages/index.mdx
Errors in ./content/wallets/pages/smart-wallets/quickstart/index.mdx
Errors in ./content/changelog/2025-08-28.md
|
SahilAujla
approved these changes
Apr 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to @andra-catana's #1235 addressing @daniel's review feedback.
What Daniel asked for
Chain-level descriptions don't render anywhere useful. API reference pages are method-specific, not chain-specific — the expanded
info.descriptionand per-server descriptions ininjective.yamldon't surface on the docs site. Move that prose onto the individual method definitions in_components/injective/methods.yamlwhere it actually renders on the method reference pages. Revertinjective.yamlto the canonical minimal pattern used by every other chain spec.Debug API has its own dedicated OpenRPC spec.
debug_*methods don't belong in a chain spec or its method components — they live in the Debug API product spec. Remove anydebug_*definitions from the Injective chain components, removedebug_*refs frominjective.yaml, and replace inline Debug documentation in the Injective MDX pages with a link to the Debug API docs.What this PR changes (vs current
main)src/openrpc/chains/injective/injective.yamlinfo.descriptionback toA specification of the standard JSON-RPC methods for Injective.(canonical minimal form, matches every other chain).serversentries carry onlyurlandname; no description expansions.eth_getBlockReceipts,eth_syncing,net_listening. Every other method still refs the shared_components/custom/methods.yamlor_components/evm/methods.yaml.debug_*refs present.src/openrpc/chains/_components/injective/methods.yaml(new)eth_getBlockReceipts,eth_syncing,net_listening.debug_*definitions.content/api-reference/injective/injective-api-overview.mdx/docs/reference/debug-api-quickstartand/docs/reference/debug-api-endpoints. Plan requirement is flagged there.content/api-reference/injective/injective-api-faq.mdxeth_getBlockReceipts/eth_syncing/net_listeningare testnet-only (each method page carries the full callout), and directsdebug_*users to the Debug API docs.content/api-reference/injective/injective-api-quickstart.mdx0x6f0/ 1776) and testnet (0x59f/ 1439), points at the overview for the full method list, and at the Debug API fordebug_*.your-api-keyreference withYOUR_API_KEYand adds a one-liner showing the Injective Testnet endpoint URL.Daikon notes
injective.yaml— Daikon'supdateSpecsFromDaikonWorkflowmanages method refs and server endpoints but does not overwriteinfo.descriptionor arbitrary fields we didn't touch. Reverting the description expansions is safe._components/injective/methods.yaml— manual territory. Daikon doesn't touch per-method definitions.x-bot-ignoreentries added. No methods removed; this PR only relocates description prose and excludesdebug_*(which the bot wouldn't have added here anyway).Verification
Confirmed in the compiled
content/api-specs/chains/injective.json:info.descriptionis the minimal canonical string.servers[*]have onlyurl/name.eth_getBlockReceipts,eth_syncing,net_listeningcarry the Injective testnet-only callout in theirdescription.methods.filter(m => m.name.startsWith('debug_')).length === 0.Coordination
Andra and Daniel can merge whichever PR makes sense — this branch or a squash of this on top of #1235. The commit carries
Co-authored-by: andra.catana <andra.catana@alchemy.com>so attribution survives either path.Resolves the review feedback on #1235.