docs: update non-tutorial Platform docs against current public repos#139
docs: update non-tutorial Platform docs against current public repos#139thephez merged 4 commits intodashpay:3.1.0from
Conversation
📝 WalkthroughWalkthroughDocumentation and Sphinx configuration updates across multiple docs clarify current Platform state, replace outdated pre-release references with links to the public monorepo and Platform Book, adjust technical notes (protoc version, proof decoding, fee wording), and expand conf.py excludes for local/IDE artifacts. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
vivekgsharma
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (4)
docs/explanations/platform-protocol.md (1)
45-47: Consider linking “release notes” directly.A concrete URL here would make the guidance immediately actionable for readers.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/explanations/platform-protocol.md` around lines 45 - 47, Update the markdown so the "release notes" text in the sentence that links to the Dash Platform monorepo becomes a direct hyperlink to the project's release notes page; locate the sentence containing "Platform Protocol evolves together with the public Dash Platform codebase" and the existing link labeled "Dash Platform monorepo" and replace or augment the plain "release notes" text with the concrete URL to the release notes (keep the existing monorepo link intact and make "release notes" point to the releases/notes page).docs/reference/platform-proofs.md (1)
60-63: Clarify exactly which proof fields include the 4-byte version prefix.“Some proof payloads” is still ambiguous for implementers. Please name the affected field(s) or add a short rule so decoders don’t strip bytes incorrectly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/reference/platform-proofs.md` around lines 60 - 63, Replace the vague sentence "Some proof payloads include a 4-byte protocol version prefix…" with an explicit list of the exact proof fields that include the 4-byte prefix (i.e., enumerate each field name referenced in this doc that must be stripped) or, if listing fields is impractical, add a short deterministic rule (e.g., "Only strip the 4-byte prefix for fields explicitly documented as 'versioned' or whose field name ends with a specific suffix; do not strip for other fields") so implementers know exactly when to remove the prefix; update the sentence that mentions "CBOR-encoded value" to reference those listed field names (or the rule) so decoders can apply the behavior unambiguously.docs/resources/repository-overview.md (2)
43-46: Consider clarifying that these components live in the monorepo.The removed links for
DAPI / rs-dapi,rs-drive,rs-dpp, anddashmatenow present these as plain text. Since line 9 already directs readers to the dashpay/platform repository as the public source tree, this approach reduces maintenance overhead and aligns with the PR's strategy.However, you might consider adding a brief note (e.g., "All components listed below are part of the monorepo") to make the intent explicit for readers who might expect individual links.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/resources/repository-overview.md` around lines 43 - 46, Add a short clarifying sentence to the repository overview that the listed components (DAPI / rs-dapi, rs-drive, rs-dpp, dashmate) are part of the monorepo: locate the table rows referencing "DAPI / rs-dapi", "rs-drive", "rs-dpp", and "dashmate" and add one concise line above or below the table such as "All components listed below live in this monorepo." to make the intent explicit for readers.
58-59: Consider adding a note about contracts living in the monorepo.Similar to the Platform components table, the removal of links for
dashpay-contractanddpns-contractis consistent with directing readers to the top-level monorepo. A brief clarifying note could help readers understand where to find these within the repository structure.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/resources/repository-overview.md` around lines 58 - 59, Add a brief clarifying note immediately after the table listing dashpay-contract and dpns-contract explaining that these contract document schemas live in the top-level monorepo rather than inline in this docs repo; update the paragraph near the table that references the Platform components to mention the monorepo location for dashpay-contract and dpns-contract and, if desired, point readers to the monorepo root for links or navigation (refer to the table entries "dashpay-contract" and "dpns-contract" to locate where to insert this note).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@docs/explanations/platform-protocol.md`:
- Around line 45-47: Update the markdown so the "release notes" text in the
sentence that links to the Dash Platform monorepo becomes a direct hyperlink to
the project's release notes page; locate the sentence containing "Platform
Protocol evolves together with the public Dash Platform codebase" and the
existing link labeled "Dash Platform monorepo" and replace or augment the plain
"release notes" text with the concrete URL to the release notes (keep the
existing monorepo link intact and make "release notes" point to the
releases/notes page).
In `@docs/reference/platform-proofs.md`:
- Around line 60-63: Replace the vague sentence "Some proof payloads include a
4-byte protocol version prefix…" with an explicit list of the exact proof fields
that include the 4-byte prefix (i.e., enumerate each field name referenced in
this doc that must be stripped) or, if listing fields is impractical, add a
short deterministic rule (e.g., "Only strip the 4-byte prefix for fields
explicitly documented as 'versioned' or whose field name ends with a specific
suffix; do not strip for other fields") so implementers know exactly when to
remove the prefix; update the sentence that mentions "CBOR-encoded value" to
reference those listed field names (or the rule) so decoders can apply the
behavior unambiguously.
In `@docs/resources/repository-overview.md`:
- Around line 43-46: Add a short clarifying sentence to the repository overview
that the listed components (DAPI / rs-dapi, rs-drive, rs-dpp, dashmate) are part
of the monorepo: locate the table rows referencing "DAPI / rs-dapi", "rs-drive",
"rs-dpp", and "dashmate" and add one concise line above or below the table such
as "All components listed below live in this monorepo." to make the intent
explicit for readers.
- Around line 58-59: Add a brief clarifying note immediately after the table
listing dashpay-contract and dpns-contract explaining that these contract
document schemas live in the top-level monorepo rather than inline in this docs
repo; update the paragraph near the table that references the Platform
components to mention the monorepo location for dashpay-contract and
dpns-contract and, if desired, point readers to the monorepo root for links or
navigation (refer to the table entries "dashpay-contract" and "dpns-contract" to
locate where to insert this note).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 9189369e-de2b-4835-bd0f-b4613e7bfe01
📒 Files selected for processing (12)
conf.pydocs/explanations/dpns.mddocs/explanations/fees.mddocs/explanations/platform-protocol.mddocs/index.mddocs/intro/what-is-dash-platform.mddocs/reference/platform-proofs.mddocs/resources/faq.mddocs/resources/repository-overview.mddocs/sdk-rs/overview.mddocs/sdk-rs/quick-start.mddocs/tutorials/building-platform.md
thephez
changed the title
thephez
left a comment
thephez
left a comment
There was a problem hiding this comment.
Thanks for the updates! A few comments and suggestions below...
thepastaclaw
left a comment
thepastaclaw
left a comment
There was a problem hiding this comment.
Good cleanup overall — removes stale pre-mainnet language and adds useful pointers to the monorepo and Platform Book. A few things I noticed:
Minor issues:
-
mock_fetch.rs/mock_fetch_many.rslinks (sdk-rs/overview.md): Changed from/blob/master/to/tree/master/. For individual files,/blob/is the correct GitHub URL format (/tree/is for directories). GitHub does redirect, but it's a 301 — better to keep them as/blob/. -
Branch references: Several links point to
master, but the default branch isv3.1-dev.masterexists and works, but may fall behind active development. Worth considering whether to usemasteror the default branch consistently. -
Protobuf version (
sdk-rs/quick-start.md): Updated from v26.1 → v32.0, but the latest release is v34.1. If we're bumping this, might as well go to a more current version. -
SDK Availability table (
repository-overview.md): Says "Planned in v3.1" / "Planned in v3.2" for iOS/Android. The upstream README says "Coming in v3.1" / "Coming in v3.2" — minor wording mismatch. -
Version table removal (
platform-protocol.md): The old per-version table is removed entirely. The replacement text says "see the monorepo and release notes" but doesn't actually link to the releases page. Adding that link would make the pointer actionable. -
Package links removed (
repository-overview.md): The component tables drop the direct links to specific packages inside the monorepo. Those links were handy for navigating straight to a crate. Consider keeping them — the table already says to treat the monorepo as source of truth, and direct links don't conflict with that.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/sdk-rs/quick-start.md (1)
175-180: Updated documentation pointers align well with current Platform state.The change from
attentiontonoteis appropriate for this informational guidance, and pointing users to the monorepo and Platform Book removes stale references to pre-release documentation. The note about hosted docs potentially lagging provides helpful context about documentation freshness.Optional: The phrase "lag behind" (line 178) could be simplified to "lag" if preferred, though the current wording is clear and natural.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/sdk-rs/quick-start.md` around lines 175 - 180, Update the note block that currently reads "Hosted API docs may lag behind the latest source changes." inside the :::{note} snippet by simplifying the phrasing to "Hosted API docs may lag the latest source changes." — locate the :::{note} block in quick-start.md (the note that references the Dash Platform monorepo and Platform Book) and replace the sentence accordingly so the wording is shorter while preserving the same meaning.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/resources/repository-overview.md`:
- Around line 21-24: The SDK links in the table (js-evo-sdk, rs-sdk, rs-sdk-ffi,
swift-sdk, wasm-sdk) currently point to tree/master but should target the
release branch/tag for version 3.1.0; update each URL to use the correct branch
or tag (e.g., replace /tree/master with /tree/v3.1-dev or /tree/3.1.0) so the
documentation references the intended v3.1 codebase consistently.
---
Nitpick comments:
In `@docs/sdk-rs/quick-start.md`:
- Around line 175-180: Update the note block that currently reads "Hosted API
docs may lag behind the latest source changes." inside the :::{note} snippet by
simplifying the phrasing to "Hosted API docs may lag the latest source changes."
— locate the :::{note} block in quick-start.md (the note that references the
Dash Platform monorepo and Platform Book) and replace the sentence accordingly
so the wording is shorter while preserving the same meaning.
🪄 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: 2ba57e93-4f03-4f08-aee4-fd950e813d4b
📒 Files selected for processing (7)
docs/explanations/dpns.mddocs/explanations/platform-protocol.mddocs/intro/what-is-dash-platform.mddocs/resources/faq.mddocs/resources/repository-overview.mddocs/sdk-rs/overview.mddocs/sdk-rs/quick-start.md
✅ Files skipped from review due to trivial changes (3)
- docs/explanations/dpns.md
- docs/explanations/platform-protocol.md
- docs/sdk-rs/overview.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/resources/faq.md
thephez
left a comment
thephez
left a comment
There was a problem hiding this comment.
Looks okay to me, but waiting to see if anyone else has feedback. The whole rs-sdk section is likely to go away and maybe just be replaced by a link to crate docs for it so I didn't look at it closely.
|
The PR has been open for a week and all comments have been addressed. Merging. |
3 participants
Summary
Refreshes the user-facing, non-tutorial Platform docs to better match the current public Platform project.
This PR keeps the work in
dashpay/docs-platformand uses the publicdashpay/platformrepo plus the Platform Book as reference materialWhat changed
exclude_patternsso local workspace artifacts like.venv/andCLAUDE.mddo not get pulled into docs buildsScope
Verification
python3 -m sphinx -M html . _buildPreview build: https://dash-docs-platform--139.org.readthedocs.build/en/139/
Summary by CodeRabbit
Documentation
Chores