Skip to content

docs: fix SDK API reference snippets - #469

Draft
MuncleUscles wants to merge 1 commit into
mainfrom
docs/weekly-docs-gap-2026-08-31-sdk-snippets
Draft

docs: fix SDK API reference snippets#469
MuncleUscles wants to merge 1 commit into
mainfrom
docs/weekly-docs-gap-2026-08-31-sdk-snippets

Conversation

@MuncleUscles

Copy link
Copy Markdown
Member

Summary

  • Fix invalid TypeScript and Python snippets in the GenLayerJS and GenLayerPY API reference pages.
  • Align the write-contract examples with the documented SDK parameter names and transaction hash variable names.
  • Remove a stale read-contract option from the quick GenLayerJS example.

Sanitized evidence basis

A weekly gap-loop source audit found copy-paste and syntax issues in the public SDK API reference snippets. These pages are used by builders as quick-start references, so broken snippets can create unnecessary onboarding friction even without a fresh support thread.

Test plan

  • pnpm build — passed locally.
  • Python code fences in pages/api-references/genlayer-py.md parse with ast.parse.

Created by weekly docs-and-skills gap loop; draft for human review.

@netlify

netlify Bot commented Aug 31, 2026

Copy link
Copy Markdown

Deploy Preview for genlayer-docs ready!

Name Link
🔨 Latest commit c491b5c
🔍 Latest deploy log https://app.netlify.com/projects/genlayer-docs/deploys/6a9543ff636ebf0008bdf394
😎 Deploy Preview https://deploy-preview-469--genlayer-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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.

1 participant