Skip to content

docs: add builder fit and consensus guidance#416

Merged
MuncleUscles merged 1 commit into
mainfrom
docs/builder-fit-consensus-faq
May 20, 2026
Merged

docs: add builder fit and consensus guidance#416
MuncleUscles merged 1 commit into
mainfrom
docs/builder-fit-consensus-faq

Conversation

@MuncleUscles
Copy link
Copy Markdown
Member

@MuncleUscles MuncleUscles commented May 20, 2026

Summary

  • Add a builder-facing guide for deciding when to use GenLayer vs frontend/backend AI
  • Clarify that the accepted leader result is what contracts store while validators verify/reject
  • Add practical web rendering guidance for JS-heavy pages using wait_after_loaded
  • Add dispute-resolution caveat language to use cases

Test Plan

  • pnpm build

Summary by CodeRabbit

  • Documentation
    • Added new comprehensive guide on when to use GenLayer, including suitability criteria, architecture patterns, and best practices checklist.
    • Enhanced web content fetching documentation with guidance on JavaScript rendering and handling dynamic pages.
    • Clarified intelligent contract leader/validator patterns and dispute resolution expectations.

Review Change Stack

@netlify
Copy link
Copy Markdown

netlify Bot commented May 20, 2026

Deploy Preview for genlayer-docs ready!

Name Link
🔨 Latest commit f33991a
🔍 Latest deploy log https://app.netlify.com/projects/genlayer-docs/deploys/6a0d8dd2e8104200081efefa
😎 Deploy Preview https://deploy-preview-416--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
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b46b86a3-00dd-4568-91d5-f5f60d09da71

📥 Commits

Reviewing files that changed from the base of the PR and between 85e5f14 and f33991a.

📒 Files selected for processing (5)
  • pages/developers/intelligent-contracts/_meta.json
  • pages/developers/intelligent-contracts/equivalence-principle.mdx
  • pages/developers/intelligent-contracts/examples/fetch-web-content.mdx
  • pages/developers/intelligent-contracts/when-to-use-genlayer.mdx
  • pages/understand-genlayer-protocol/typical-use-cases.mdx

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation to guide GenLayer builders on fit assessment and architectural patterns. It introduces a new "When to Use GenLayer" guide covering fit criteria and anti-patterns, clarifies leader/validator result persistence semantics, improves web content fetching examples, and cross-links builder decision guidance with legal disclaimers in the use-cases section.

Changes

Documentation Guidance and Patterns

Layer / File(s) Summary
New When to Use GenLayer Guide
pages/developers/intelligent-contracts/_meta.json, pages/developers/intelligent-contracts/when-to-use-genlayer.mdx
A complete guide for builders defining when GenLayer is a good fit (markets, disputes, milestone workflows, rule verification) versus weak fits (frontend-computed answers, generic AI use, unverifiable private data, unbounded subjective outputs). Includes architecture patterns (frontend/backend, intelligent contract, validators), component responsibilities, and a pre-build design checklist. Page is registered in navigation metadata.
Leader/Validator Pattern Clarification
pages/developers/intelligent-contracts/equivalence-principle.mdx
Informational callout under the Leader/Validator Pattern explaining that only the accepted leader result is stored by the contract, validators' intermediate computations are not persisted, and multiple perspectives must be explicitly modeled as validated fields in the leader result.
Web Content Fetching and Dynamic Pages
pages/developers/intelligent-contracts/examples/fetch-web-content.mdx
Clarifies that gl.nondet.web.render() should be used instead of get() when JavaScript execution or DOM rendering is required. Introduces "Waiting for Dynamic Pages" section documenting the wait_after_loaded parameter with text-mode examples, guidance on determinism trade-offs, and warnings that dynamic content must be equivalence-validated at the field level.
Use Cases Builder Fit and Legal Disclaimers
pages/understand-genlayer-protocol/typical-use-cases.mdx
Adds cross-link to builder fit checklist to help developers decide whether a feature belongs on GenLayer versus a normal backend. Introduces disclaimer that GenLayer supports dispute workflows but is not a court, does not automatically bind outcomes legally, and legal/contractual use still requires agreements, jurisdiction, and escalation processes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • cristiam86
  • kp2pml30

Poem

🐇 A guide for builders, clear and bright,
When GenLayer fits—and when it might not quite,
Validators dance, leaders decide,
Render the web with JavaScript inside,
One hop closer to smart contracts done right! 🎯

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main changes: adding builder-fit guidance and consensus clarification across documentation.
Description check ✅ Passed The description provides a clear summary of changes and includes a test plan, though it lacks some Conventional Commits formatting details.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/builder-fit-consensus-faq

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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 and usage tips.

@MuncleUscles MuncleUscles merged commit 5b64908 into main May 20, 2026
8 checks passed
@MuncleUscles MuncleUscles deleted the docs/builder-fit-consensus-faq branch May 20, 2026 10:44
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