Skip to content

docs: surface Evo SDK site and add example-app cards#158

Merged
thephez merged 3 commits into
dashpay:4.0.0from
thephez:chore/small-improvements
Jul 20, 2026
Merged

docs: surface Evo SDK site and add example-app cards#158
thephez merged 3 commits into
dashpay:4.0.0from
thephez:chore/small-improvements

Conversation

@thephez

@thephez thephez commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

Improves discoverability of the Evo SDK tooling and the example apps across the tutorials and resources sections.

Changes

Evo SDK references — Point developers to the Evo SDK site (playground, docs, AI reference):

  • Add a "Try it in the browser" section to the tutorials introduction and a playground tip on the connecting-to-testnet page.
  • Add an Evo SDK site paragraph to the repository overview.
  • Update the SDK documentation link to evo-sdk.dash.org/docs.html and reorder the Resources toctree.

Example-app cards — Give the example-apps index a visual entry point:

  • Add a card grid with cropped screenshot previews and "try it live" buttons for DashMint Lab and Dashnote.
  • Add matching live-demo buttons to each walkthrough page.
  • Add CSS to crop/zoom the card screenshots and hide the now-redundant toctree.

Preview build: https://dash-docs-platform--158.org.readthedocs.build/en/158/

Summary by CodeRabbit

  • New Features

    • Added browser-based Evo SDK Playground guidance for trying queries without local setup.
    • Added example app cards for DashMint Lab and Dashnote, with links to try each app live.
    • Enhanced example app previews with improved zooming and responsive sizing.
  • Documentation

    • Updated resource links and SDK references across the documentation.
    • Added information about SDK tools, documentation, AI references, and live network access.
    • Improved setup instructions and example app navigation.

thephez and others added 2 commits July 15, 2026 13:45
Surface the Evo SDK site (playground, docs, AI reference) across tutorials and resources, and reorder the Resources toctree.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a card grid to the example-apps index with cropped screenshot previews and "try it live" buttons, add matching live-demo buttons to the DashMint Lab and Dashnote walkthroughs, and hide the now-redundant toctree.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@thephez, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 8 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2182e572-ca98-478f-bc16-8f1e4df239be

📥 Commits

Reviewing files that changed from the base of the PR and between 4922fcc and 1a4c399.

📒 Files selected for processing (1)
  • docs/tutorials/introduction.md
📝 Walkthrough

Walkthrough

Updates documentation to promote Evo SDK browser resources, adds an example-app gallery with live-demo links, and adjusts example-app card image styling for responsive layouts.

Changes

Documentation and example apps

Layer / File(s) Summary
SDK discovery and browser guidance
docs/index.md, docs/resources/repository-overview.md, docs/tutorials/connecting-to-testnet.md, docs/tutorials/introduction.md, docs/tutorials/setup-sdk-client.md
Adds Evo SDK playground and documentation references, updates an SDK documentation URL, and reformats setup-file links.
Example app gallery and live demos
docs/tutorials/example-apps.md, docs/tutorials/example-apps/*, _static/css/pydata-overrides.css
Adds DashMint Lab and Dashnote cards, hidden walkthrough navigation, live-demo buttons, and responsive zoomed card images.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 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 matches the main changes: surfacing the Evo SDK site and adding example-app cards.
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.
✨ 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
docs/tutorials/introduction.md (1)

22-22: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Use an em-dash for consistency.

The text uses a double hyphen (--) instead of an em-dash (), which is used elsewhere in this file (e.g., lines 41-42).

♻️ Proposed fix
-You can clone a repository containing the code for all tutorials from <a href="https://github.com/dashpay/platform-readme-tutorials#readme" target="_blank">GitHub</a> or download it as a [zip file](https://github.com/dashpay/platform-readme-tutorials/archive/refs/heads/main.zip). Or, use the [Evo SDK playground](https://evo-sdk.dash.org/playground) to instantly experiment with tutorial queries -- no local setup required.
+You can clone a repository containing the code for all tutorials from <a href="https://github.com/dashpay/platform-readme-tutorials#readme" target="_blank">GitHub</a> or download it as a [zip file](https://github.com/dashpay/platform-readme-tutorials/archive/refs/heads/main.zip). Or, use the [Evo SDK playground](https://evo-sdk.dash.org/playground) to instantly experiment with tutorial queries — no local setup required.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/tutorials/introduction.md` at line 22, Replace the double hyphen before
“no local setup required” in the tutorial introduction with an em-dash,
preserving the surrounding links and wording.
docs/resources/repository-overview.md (1)

26-27: 📐 Maintainability & Code Quality | 🔵 Trivial | 💤 Low value

Inconsistent URL for the Evo SDK Playground.

The playground URL includes .html here, but is referenced as https://evo-sdk.dash.org/playground (without .html) in docs/index.md and docs/tutorials/connecting-to-testnet.md. Please consider removing .html for consistency.

♻️ Proposed fix
-The [Evo SDK site](https://evo-sdk.dash.org/) hosts developer-facing tooling for the JavaScript SDK: an interactive [playground](https://evo-sdk.dash.org/playground.html) that runs read-only queries in the browser against testnet, [SDK documentation](https://evo-sdk.dash.org/docs.html), and an AI reference.
+The [Evo SDK site](https://evo-sdk.dash.org/) hosts developer-facing tooling for the JavaScript SDK: an interactive [playground](https://evo-sdk.dash.org/playground) that runs read-only queries in the browser against testnet, [SDK documentation](https://evo-sdk.dash.org/docs.html), and an AI reference.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/resources/repository-overview.md` around lines 26 - 27, Update the
playground link in the Evo SDK site description to use the canonical URL without
the .html suffix, matching the references in the other documentation files.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/tutorials/introduction.md`:
- Around line 35-36: Correct the introductory sentence by adding “to” after the
link to the Evo SDK site, so it reads naturally as an instruction to visit the
site to run queries while preserving the existing links and remaining wording.

---

Nitpick comments:
In `@docs/resources/repository-overview.md`:
- Around line 26-27: Update the playground link in the Evo SDK site description
to use the canonical URL without the .html suffix, matching the references in
the other documentation files.

In `@docs/tutorials/introduction.md`:
- Line 22: Replace the double hyphen before “no local setup required” in the
tutorial introduction with an em-dash, preserving the surrounding links and
wording.
🪄 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: 61df5586-01cf-4630-9563-066babcb78b5

📥 Commits

Reviewing files that changed from the base of the PR and between 9fcf97e and 4922fcc.

📒 Files selected for processing (9)
  • _static/css/pydata-overrides.css
  • docs/index.md
  • docs/resources/repository-overview.md
  • docs/tutorials/connecting-to-testnet.md
  • docs/tutorials/example-apps.md
  • docs/tutorials/example-apps/dashmint-lab.md
  • docs/tutorials/example-apps/dashnote.md
  • docs/tutorials/introduction.md
  • docs/tutorials/setup-sdk-client.md

Comment thread docs/tutorials/introduction.md Outdated
@thephez
thephez merged commit bf3c1a8 into dashpay:4.0.0 Jul 20, 2026
1 of 2 checks passed
@thephez
thephez deleted the chore/small-improvements branch July 20, 2026 19:10
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