Skip to content

docs: fix schema-write variable declarations - #3226

Open
DeepanshuPal wants to merge 1 commit into
Permify:masterfrom
DeepanshuPal:docs/fix-schema-write-declarations
Open

DeepanshuPal wants to merge 1 commit into
Permify:masterfrom
DeepanshuPal:docs/fix-schema-write-declarations

Conversation

@DeepanshuPal

@DeepanshuPal DeepanshuPal commented Oct 4, 2026 •

Copy link
Copy Markdown

Fixes const. body to const body in the JavaScript, TypeScript and Node schema-write examples in the end-to-end guide. The extra period prevents all three snippets from parsing before they can send a schema.

Validation: all three original snippets fail TypeScript parsing; all three corrected snippets parse and pass a local mocked payload test. No network calls or real schema writes were made. The full Mintlify build and repository suite were not run.

Summary by CodeRabbit

  • Documentation
    • Corrected a declaration in the JavaScript, TypeScript, and Node schema-write examples.

@github-actions

github-actions Bot commented Oct 4, 2026 •

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@coderabbitai

coderabbitai Bot commented Oct 4, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 38f4beba-dcd4-402c-95a0-39474d8f693b
📥 Commits

Reviewing files that changed from the base of the PR and between 93186e8 and f3113bc.

📒 Files selected for processing (1)
  • docs/getting-started/end-to-end-example.mdx

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.


📝 Walkthrough

Walkthrough

The end-to-end example documentation corrects the body declaration in the JavaScript, TypeScript, and Node schema-write examples.

Changes

Schema-write examples

Layer / File(s) Summary
Correct schema-write declarations
docs/getting-started/end-to-end-example.mdx
The JavaScript, TypeScript, and Node examples replace const. body with const body.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to f3113

The examples now use valid body declarations, with no identified behavior change. No actionable merge-blocking risk remains.

Architecture Summary

Architecture risk: 🔵 Low · up to f3113

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/getting-started/end-to-end-example.mdx: The JavaScript schema-write example changes the body declaration from the invalid const. body form to const body.
  • observed — Modified behavior in docs/getting-started/end-to-end-example.mdx: The TypeScript schema-write example changes the body declaration from the invalid const. body form to const body.
  • observed — Modified behavior in docs/getting-started/end-to-end-example.mdx: The Node schema-write example changes the body declaration from the invalid const. body form to const body.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation fix: correcting schema-write variable declarations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@DeepanshuPal

Copy link
Copy Markdown
Author

I have read the CLA Document and I hereby sign the CLA

github-actions Bot added a commit that referenced this pull request Oct 4, 2026

This branch has not been deployed

No deployments
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