docs(developers): add quick start guide by dhozil · Pull Request #374 · genlayerlabs/genlayer-docs

dhozil · 2026-03-29T05:09:39Z

What

Adds a new Quick Start page for developers new to GenLayer.

Why

Currently there is no single linear path from zero to a running
contract. New developers land on the docs and have to piece together
information from multiple pages (Development Setup, Your First Contract,
Your First Intelligent Contract) without a clear starting point.

Changes

Add pages/developers/intelligent-contracts/quick-start.mdx
Update _meta.json to show Quick Start first in the sidebar
Update homepage to link directly to Quick Start

Summary by CodeRabbit

Documentation
- Added a comprehensive Quick Start guide for Intelligent Contracts covering environment options, contract examples, testing, linting, deployment, Studio/CLI workflows, and next-step links.
- Added a "Quick Start" metadata entry so the docs route is named accordingly.
- Updated the homepage "For Developers" card to link directly to the new Quick Start guide.

netlify · 2026-03-29T05:09:44Z

✅ Deploy Preview for genlayer-docs ready!

Name	Link
🔨 Latest commit	`28ec564`
🔍 Latest deploy log	https://app.netlify.com/projects/genlayer-docs/deploys/69cb62635d470e0007e43e5a
😎 Deploy Preview	https://deploy-preview-374--genlayer-docs.netlify.app
📱 Preview on mobile	Toggle 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 · 2026-03-29T05:09:55Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d11731c3-8bfe-47ed-8fbe-bed81b2a4fe3

📥 Commits

Reviewing files that changed from the base of the PR and between 0a4d237 and 28ec564.

📒 Files selected for processing (1)

pages/developers/intelligent-contracts/quick-start.mdx

✅ Files skipped from review due to trivial changes (1)

pages/developers/intelligent-contracts/quick-start.mdx

📝 Walkthrough

Walkthrough

Adds a new "Quick Start" documentation page for Intelligent Contracts, registers it in the route metadata, and updates the home page "For Developers" card to link directly to the new quick-start guide.

Changes

Cohort / File(s)	Summary
Intelligent Contracts Quick Start `pages/developers/intelligent-contracts/_meta.json`, `pages/developers/intelligent-contracts/quick-start.mdx`	Added `quick-start` metadata entry and created a Quick Start MDX guiding hosted Studio and local workflows, project scaffold, linting/tests, CLI deploy/call examples, and a SentimentChecker example using `gl.nondet.exec_prompt` and `gl.eq_principle.strict_eq`.
Home Page Navigation `pages/index.mdx`	Updated the "For Developers" card link to point to `/developers/intelligent-contracts/quick-start`.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

feat: add deploy section to docs #249: Edits the same docs area and updates pages/developers/intelligent-contracts/_meta.json with navigation entries.

Suggested reviewers

cristiam86

Poem

🐇✨ A quick-start hop, all set to go,
Contracts in Python, a tidy flow.
Lint, test, deploy — then let it play,
Sentiment checked in a clever way.
Hop to the docs, and brighten your day!

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description provides a clear 'What' (new Quick Start page), 'Why' (single onboarding path), 'Changes' (three modifications), and a 'Related' reference to the issue. However, it does not address reviewer feedback about reordering content, fixing the PriceFeed example, or removing the non-existent 'What's next' link.	Address reviewer comments: reorder steps to lead with studio.genlayer.com, fix or replace the PriceFeed example to avoid strict_eq validator issues, and remove the non-existent 'What's next' page link before merging.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs(developers): add quick start guide' is concise, follows Conventional Commits format, and accurately describes the main addition of a Quick Start guide page to the developer documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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.}

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@pages/developers/intelligent-contracts/quick-start.mdx`:
- Line 63: Update the install command so shells like zsh don't treat the square
brackets as glob patterns: replace the unquoted "pip install genlayer-test[sim]"
invocation with a quoted form (e.g. use single quotes around genlayer-test[sim])
wherever the string "pip install genlayer-test[sim]" appears in the file
pages/developers/intelligent-contracts/quick-start.mdx so the command is
portable across shells.
- Line 44: Clarify that the package name `genvm-linter` installs the CLI that
exposes the `genvm-lint` command: update the introduction text where
`genvm-linter` is first mentioned to state something like “Install the package
`genvm-linter` which provides the `genvm-lint` CLI (used as `genvm-lint check`)”
so readers understand `genvm-linter` is the package and `genvm-lint` is the
command; reference the package name `genvm-linter` and the command `genvm-lint
check` explicitly in that sentence.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1c76fceb-ba47-4fb6-8a70-485e3d2327db

📥 Commits

Reviewing files that changed from the base of the PR and between 27d1f6c and f4e4ff2.

📒 Files selected for processing (3)

pages/developers/intelligent-contracts/_meta.json
pages/developers/intelligent-contracts/quick-start.mdx
pages/index.mdx

pages/developers/intelligent-contracts/quick-start.mdx

MuncleUscles · 2026-03-30T12:00:54Z

Great guide — well structured and good use of Nextra components.

A few things:

Lead with studio.genlayer.com — the fastest path to a running contract is zero-install: open the browser, pick an example, deploy. Right now that's buried at the bottom. It should be the first thing, with local setup as step 2.
PriceFeed example will fail — strict_eq requires byte-identical results, but prices drift between leader and validator execution. Use gl.vm.run_nondet_unsafe with a leader/validator function and numeric tolerance instead. See the Price Oracle example in the Equivalence Principle docs.
Dead link — "What's next" links to a best practices page that doesn't exist. Remove that link.

coderabbitai

🧹 Nitpick comments (1)

pages/developers/intelligent-contracts/quick-start.mdx (1)

188-188: Optional wording trim for concision.

Consider shortening “make a decision on-chain” to “decide on-chain” for tighter phrasing.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@pages/developers/intelligent-contracts/quick-start.mdx` at line 188, Replace
the phrase "make a decision on-chain" with the more concise "decide on-chain" in
the sentence that currently reads "Now add what no regular smart contract can do
— call an LLM to make a decision on-chain:" so it becomes "Now add what no
regular smart contract can do — call an LLM to decide on-chain:"; update the
surrounding sentence accordingly to keep punctuation and emphasis intact.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@pages/developers/intelligent-contracts/quick-start.mdx`:
- Line 188: Replace the phrase "make a decision on-chain" with the more concise
"decide on-chain" in the sentence that currently reads "Now add what no regular
smart contract can do — call an LLM to make a decision on-chain:" so it becomes
"Now add what no regular smart contract can do — call an LLM to decide
on-chain:"; update the surrounding sentence accordingly to keep punctuation and
emphasis intact.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9a481baa-ebf9-47a5-b6bf-49127f14fa3b

📥 Commits

Reviewing files that changed from the base of the PR and between f4e4ff2 and f59a89e.

📒 Files selected for processing (1)

pages/developers/intelligent-contracts/quick-start.mdx

dhozil added 3 commits March 29, 2026 11:46

Create quick-start.mdx

527079f

Update _meta.json

f3a94bf

Update index.mdx

f4e4ff2

coderabbitai bot reviewed Mar 29, 2026

View reviewed changes

pages/developers/intelligent-contracts/quick-start.mdx Outdated Show resolved Hide resolved

pages/developers/intelligent-contracts/quick-start.mdx Outdated Show resolved Hide resolved

Update quick-start.mdx

f59a89e

coderabbitai bot reviewed Mar 30, 2026

View reviewed changes

dhozil added 2 commits March 31, 2026 04:45

Update quick-start.mdx

0a4d237

Update quick-start.mdx

28ec564

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(developers): add quick start guide#374

docs(developers): add quick start guide#374
dhozil wants to merge 6 commits intogenlayerlabs:mainfrom
dhozil:add/quick-start-guide

dhozil commented Mar 29, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Mar 29, 2026 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 29, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

MuncleUscles commented Mar 30, 2026

Uh oh!

coderabbitai bot left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

dhozil commented Mar 29, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What

Why

Changes

Related

Summary by CodeRabbit

Uh oh!

netlify bot commented Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for genlayer-docs ready!

Uh oh!

coderabbitai bot commented Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

MuncleUscles commented Mar 30, 2026

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

dhozil commented Mar 29, 2026 •

edited by coderabbitai bot

Loading

netlify bot commented Mar 29, 2026 •

edited

Loading

coderabbitai bot commented Mar 29, 2026 •

edited

Loading