From 708e8af1ffb387fe3817a23261c61421ffc2c91f Mon Sep 17 00:00:00 2001 From: TheFirstNomad <119462780+TheFirstNomad@users.noreply.github.com> Date: Wed, 22 Apr 2026 23:09:18 +0300 Subject: [PATCH] docs: add runnable example to Code examples section Added a runnable example to the Code examples section in the review checklist. This makes the guidelines more helpful for new contributors. --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d3d19bbbb..743035114 100644 --- a/README.md +++ b/README.md @@ -125,6 +125,7 @@ The Base documentation is organized into established sections (for example: `get - For alternatives, use `` / ``. - For API docs, use ``, ``, and request/response examples. + ### Code examples - Provide complete, runnable examples with realistic data. @@ -132,6 +133,12 @@ The Base documentation is organized into established sections (for example: `get - Specify language and filename when helpful. - Show expected output or verification steps. +**Example:** + +```bash +cd docs +mint dev + ## Third-party guides policy > Warning: We generally do not accept guides that primarily document a third-party product. Exceptions require a clear Base-focused use case and a tight integration with Base products. Simply deploying on Base or connecting to Base Account/Base App is not sufficient.