docs(tutorials): example apps (DashMint lite, DashProof lite, Dashnote)#147
Merged
Conversation
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Extends tutorial-sync with a `kind: copy` mapping type to mirror whole-file embed apps (DashMint Lite, DashProof Lite) from platform-tutorials into _static/. Pulls in the latest DashMint Lab contractStorage extraction, pins both lite apps to evo-sdk@3.1.0-dev.1, and tightens their intro paragraphs. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
📝 WalkthroughWalkthroughAdds three read-only demo apps (DashMint Lite, DashProof Lite, DashNote Lite) as static HTML pages, embeds them in tutorial pages, updates docs navigation and Sphinx sidebar config, updates DashMint Lab docs for a storage-helper refactor, and extends the tutorial sync script to support whole-file ChangesExample App Demos and Documentation Integration
Sequence Diagram(s)sequenceDiagram
participant Browser as Browser (embedded iframe)
participant EvoSDK as EvoSDK (client)
participant Testnet as Dash Testnet
Browser->>EvoSDK: EvoSDK.testnetTrusted() / sdk.documents.query / sdk.documents.get
EvoSDK->>Testnet: forward queries
Testnet->>EvoSDK: return document/anchor results
EvoSDK->>Browser: deliver results (array/Map/object)
Browser->>Browser: normalize results -> render UI (cards/anchors/notes)
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/tutorials/example-apps/dashproof-lite.md (1)
24-26:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUnclosed
{raw}directive fence may cause build warnings or missed iframe rendering.The
{raw}block opened on line 24 is never closed — the file ends at line 26 without a matching```. The style block earlier (lines 5–11) is correctly closed. MyST parsers vary in how they handle an unclosed fence at EOF: some silently treat the rest of the file as directive content (iframe renders), others emit a warning or drop the block entirely.🛠️ Proposed fix
```{raw} html <iframe src="../../../_static/dashproof-lite.html" width="100%" height="600"></iframe> +```🤖 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/example-apps/dashproof-lite.md` around lines 24 - 26, The markdown ends with an unclosed `{raw}` directive containing the iframe, which can cause build warnings or dropped content; close the raw fence by adding the missing closing fence ``` after the <iframe> block so the `{raw} html` directive is properly terminated (identify the `{raw}` directive opening and the iframe line containing src="../../../_static/dashproof-lite.html" and add the closing triple-backtick immediately after it).docs/tutorials/example-apps/dashmint-lite.md (1)
24-26:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winSame unclosed
{raw}directive fence asdashproof-lite.md.The
{raw}block opened on line 24 has no closing```before EOF, while the earlier style block (lines 5–11) is correctly closed.🛠️ Proposed fix
```{raw} html <iframe src="../../../_static/dashmint-lite.html" width="100%" height="600"></iframe> +```🤖 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/example-apps/dashmint-lite.md` around lines 24 - 26, The `{raw}` directive block that opens with "{raw} html" around the iframe is missing its closing backtick fence; to fix, add a closing triple-backtick (```) after the iframe line to terminate the `{raw}` block so the directive is balanced and the HTML iframe is properly contained (look for the "{raw} html" opening and the "<iframe src=\"../../../_static/dashmint-lite.html\"" line and insert the closing ``` immediately after that iframe line).
🤖 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.
Outside diff comments:
In `@docs/tutorials/example-apps/dashmint-lite.md`:
- Around line 24-26: The `{raw}` directive block that opens with "{raw} html"
around the iframe is missing its closing backtick fence; to fix, add a closing
triple-backtick (```) after the iframe line to terminate the `{raw}` block so
the directive is balanced and the HTML iframe is properly contained (look for
the "{raw} html" opening and the "<iframe
src=\"../../../_static/dashmint-lite.html\"" line and insert the closing ```
immediately after that iframe line).
In `@docs/tutorials/example-apps/dashproof-lite.md`:
- Around line 24-26: The markdown ends with an unclosed `{raw}` directive
containing the iframe, which can cause build warnings or dropped content; close
the raw fence by adding the missing closing fence ``` after the <iframe> block
so the `{raw} html` directive is properly terminated (identify the `{raw}`
directive opening and the iframe line containing
src="../../../_static/dashproof-lite.html" and add the closing triple-backtick
immediately after it).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6939af99-601e-4342-bfc0-0f0d5ca67291
📒 Files selected for processing (9)
_static/dashmint-lite.html_static/dashproof-lite.htmlconf.pydocs/tutorials/example-apps.mddocs/tutorials/example-apps/dashmint-lab.mddocs/tutorials/example-apps/dashmint-lite.mddocs/tutorials/example-apps/dashproof-lite.mdscripts/tutorial-sync/sync_tutorial_code.pyscripts/tutorial-sync/tutorial-code-map.yml
…te page Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/index.md (1)
81-89: ⚡ Quick winConsider updating the description to reflect the Lite apps added in this PR.
The card description mentions "DashMint Lab, Dashnote" but doesn't mention the Lite versions (DashMint Lite, DashProof Lite, DashNote Lite) which are the primary focus of this PR according to the objectives. Consider either listing all app types or using a more general description like "SDK example applications and interactive demos" to better represent the full range of available apps.
📝 Suggested alternatives
Option 1 (more specific):
- End-to-end SDK walkthroughs (DashMint Lab, Dashnote) + SDK example applications and interactive browser demosOption 2 (list all types):
- End-to-end SDK walkthroughs (DashMint Lab, Dashnote) + SDK walkthroughs and demos (DashMint, DashProof, Dashnote)🤖 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/index.md` around lines 81 - 89, Update the grid-item-card description text in docs/index.md (the ".. grid-item-card:: 🧩 Example apps" block that links to tutorials-example-apps) to mention the new Lite apps or use a more general phrase; specifically replace the "End-to-end SDK walkthroughs (DashMint Lab, Dashnote)" line with either a list that includes "DashMint Lite, DashProof Lite, DashNote Lite" alongside the existing names or a general description like "SDK example applications and interactive demos" so the card accurately represents the PR's added Lite apps.
🤖 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/example-apps/dashnote.md`:
- Line 2: The reStructuredText label ".. tutorials-example-apps-dashnote:" is
missing the required underscore prefix for a reference target; change it to
include the underscore (i.e., update the label string used in the docs to
"_tutorials-example-apps-dashnote" so the directive becomes "..
_tutorials-example-apps-dashnote:") to ensure cross-references to this section
resolve correctly.
---
Nitpick comments:
In `@docs/index.md`:
- Around line 81-89: Update the grid-item-card description text in docs/index.md
(the ".. grid-item-card:: 🧩 Example apps" block that links to
tutorials-example-apps) to mention the new Lite apps or use a more general
phrase; specifically replace the "End-to-end SDK walkthroughs (DashMint Lab,
Dashnote)" line with either a list that includes "DashMint Lite, DashProof Lite,
DashNote Lite" alongside the existing names or a general description like "SDK
example applications and interactive demos" so the card accurately represents
the PR's added Lite apps.
🪄 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: 7227bced-266f-4db1-9b44-f210761abb09
📒 Files selected for processing (9)
docs/index.mddocs/tutorials/contracts-and-documents/delete-documents.mddocs/tutorials/contracts-and-documents/register-a-data-contract.mddocs/tutorials/contracts-and-documents/retrieve-documents.mddocs/tutorials/contracts-and-documents/submit-documents.mddocs/tutorials/contracts-and-documents/update-documents.mddocs/tutorials/example-apps.mddocs/tutorials/example-apps/dashnote.mddocs/tutorials/introduction.md
✅ Files skipped from review due to trivial changes (6)
- docs/tutorials/contracts-and-documents/submit-documents.md
- docs/tutorials/introduction.md
- docs/tutorials/contracts-and-documents/update-documents.md
- docs/tutorials/contracts-and-documents/delete-documents.md
- docs/tutorials/contracts-and-documents/retrieve-documents.md
- docs/tutorials/contracts-and-documents/register-a-data-contract.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/tutorials/example-apps.md
thephez
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds three example apps to the v3.1 tutorial set and surfaces them from places readers actually land.
Embedded read-only apps (commits abf1533, 147cd4b)
_static/.dashmint-liteanddashproof-liteinconf.py.Dashnote walkthrough (commits cc2eb38, 26b97fd)
_static/.Discoverability (commits b372abe, f2dfaf7)
:::{tip}callouts on five per-operation tutorials linking to the matching operation inside the relevant walkthrough: submit-documents, update-documents, delete-documents, retrieve-documents, register-a-data-contract.Preview build: https://dash-docs-platform--147.org.readthedocs.build/en/147/
Summary by CodeRabbit
New Features
Documentation
Chores