docs: remove deprecated SDK/DAPI sections and reorganize repository overview#136
Merged
thephez merged 4 commits intodashpay:3.1.0from Mar 17, 2026
Merged
docs: remove deprecated SDK/DAPI sections and reorganize repository overview#136thephez merged 4 commits intodashpay:3.1.0from
thephez merged 4 commits intodashpay:3.1.0from
Conversation
They are nearly deprecated and shouldn't be represented here
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis PR removes a large set of JavaScript SDK and DAPI Client documentation files and updates the docs index and repository overview to reflect the removals and new resource links. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 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)
📝 Coding Plan
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 Tip You can make CodeRabbit's review stricter and more nitpicky using the `assertive` profile, if that's what you prefer.Change the |
![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 (1)
docs/index.md (1)
152-166:⚠️ Potential issue | 🟠 MajorRemove stale hardcoded sidebar links tied to deleted SDK/DAPI pages.
After this toctree cleanup,
_templates/sidebar-main.htmlstill contains hardcoded links to removed pages (docs/sdk-js/*,docs/resources/source-code.html), which will create broken navigation/build warnings. Please update that template in the same PR.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/index.md` around lines 152 - 166, The docs toctree was cleaned up but the sidebar-main.html template still contains hardcoded links to removed pages; open sidebar-main.html and remove any static entries pointing to the old sdk-js/* pages and to resources/source-code.html, replacing them with the dynamic Sphinx toctree/nav rendering (i.e., render the project's toctree or use built-in sidebar macros instead of hardcoded anchors) and run a link check to ensure no remaining broken references.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/index.md`:
- Around line 152-166: The docs toctree was cleaned up but the sidebar-main.html
template still contains hardcoded links to removed pages; open sidebar-main.html
and remove any static entries pointing to the old sdk-js/* pages and to
resources/source-code.html, replacing them with the dynamic Sphinx toctree/nav
rendering (i.e., render the project's toctree or use built-in sidebar macros
instead of hardcoded anchors) and run a link check to ensure no remaining broken
references.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b351140c-b29b-440c-9b05-68a478433888
📒 Files selected for processing (69)
docs/dapi-client-js/overview.mddocs/dapi-client-js/quick-start.mddocs/dapi-client-js/usage/core/broadcasttransaction.mddocs/dapi-client-js/usage/core/core.mddocs/dapi-client-js/usage/core/getbestblockhash.mddocs/dapi-client-js/usage/core/getblockbyhash.mddocs/dapi-client-js/usage/core/getblockbyheight.mddocs/dapi-client-js/usage/core/getblockhash.mddocs/dapi-client-js/usage/core/getstatus.mddocs/dapi-client-js/usage/core/gettransaction.mddocs/dapi-client-js/usage/core/subscribetoblockheaderswithchainlocks.mddocs/dapi-client-js/usage/core/subscribetomasternodelist.mddocs/dapi-client-js/usage/core/subscribetotransactionswithproofs.mddocs/dapi-client-js/usage/dapiclient.mddocs/dapi-client-js/usage/platform/broadcaststatetransition.mddocs/dapi-client-js/usage/platform/getdatacontract.mddocs/dapi-client-js/usage/platform/getdocuments.mddocs/dapi-client-js/usage/platform/getidentity.mddocs/dapi-client-js/usage/platform/getidentitybyfirstpublickey.mddocs/dapi-client-js/usage/platform/getidentityidbyfirstpublickey.mddocs/dapi-client-js/usage/platform/platform.mddocs/dapi-client-js/usage/usage.mddocs/index.mddocs/resources/repository-overview.mddocs/resources/source-code.mddocs/sdk-js/examples/examples.mddocs/sdk-js/examples/fetch-an-identity-from-its-name.mddocs/sdk-js/examples/generate-a-new-mnemonic.mddocs/sdk-js/examples/paying-to-another-address.mddocs/sdk-js/examples/receive-money-and-check-balance.mddocs/sdk-js/examples/sign-and-verify-messages.mddocs/sdk-js/examples/use-different-account.mddocs/sdk-js/getting-started/about-schemas.mddocs/sdk-js/getting-started/core-concepts.mddocs/sdk-js/getting-started/dash-platform-applications.mddocs/sdk-js/getting-started/getting-started.mddocs/sdk-js/getting-started/quick-start.mddocs/sdk-js/getting-started/with-typescript.mddocs/sdk-js/getting-started/working-with-multiple-apps.mddocs/sdk-js/overview.mddocs/sdk-js/platform/contracts/contracts.mddocs/sdk-js/platform/contracts/create.mddocs/sdk-js/platform/contracts/get.mddocs/sdk-js/platform/contracts/history.mddocs/sdk-js/platform/contracts/publish.mddocs/sdk-js/platform/contracts/update.mddocs/sdk-js/platform/documents/broadcast.mddocs/sdk-js/platform/documents/create.mddocs/sdk-js/platform/documents/documents.mddocs/sdk-js/platform/documents/get.mddocs/sdk-js/platform/identities/credit-transfer.mddocs/sdk-js/platform/identities/credit-withdrawal.mddocs/sdk-js/platform/identities/get.mddocs/sdk-js/platform/identities/identities.mddocs/sdk-js/platform/identities/register.mddocs/sdk-js/platform/identities/topup.mddocs/sdk-js/platform/identities/update.mddocs/sdk-js/platform/names/names.mddocs/sdk-js/platform/names/register.mddocs/sdk-js/platform/names/resolve.mddocs/sdk-js/platform/names/resolvebyrecord.mddocs/sdk-js/platform/names/search.mddocs/sdk-js/platform/platform.mddocs/sdk-js/usage/dapi.mddocs/sdk-js/usage/dashcore-lib-primitives.mddocs/sdk-js/usage/usage.mddocs/sdk-js/wallet/accounts.mddocs/sdk-js/wallet/signing-encrypt.mddocs/sdk-js/wallet/wallet.md
💤 Files with no reviewable changes (67)
- docs/sdk-js/platform/contracts/get.md
- docs/sdk-js/platform/contracts/update.md
- docs/dapi-client-js/usage/core/getbestblockhash.md
- docs/dapi-client-js/usage/core/gettransaction.md
- docs/dapi-client-js/usage/platform/getdatacontract.md
- docs/sdk-js/platform/names/resolve.md
- docs/dapi-client-js/usage/core/broadcasttransaction.md
- docs/sdk-js/platform/platform.md
- docs/sdk-js/platform/identities/topup.md
- docs/sdk-js/platform/identities/identities.md
- docs/sdk-js/usage/dapi.md
- docs/sdk-js/examples/examples.md
- docs/sdk-js/getting-started/core-concepts.md
- docs/dapi-client-js/usage/core/subscribetotransactionswithproofs.md
- docs/dapi-client-js/usage/core/getblockbyhash.md
- docs/sdk-js/platform/identities/get.md
- docs/dapi-client-js/overview.md
- docs/dapi-client-js/usage/platform/getidentity.md
- docs/sdk-js/getting-started/about-schemas.md
- docs/resources/source-code.md
- docs/sdk-js/platform/documents/get.md
- docs/dapi-client-js/usage/platform/broadcaststatetransition.md
- docs/sdk-js/platform/names/resolvebyrecord.md
- docs/dapi-client-js/usage/core/subscribetomasternodelist.md
- docs/sdk-js/wallet/accounts.md
- docs/sdk-js/usage/usage.md
- docs/sdk-js/examples/paying-to-another-address.md
- docs/sdk-js/examples/fetch-an-identity-from-its-name.md
- docs/sdk-js/platform/names/names.md
- docs/dapi-client-js/usage/usage.md
- docs/sdk-js/platform/identities/register.md
- docs/sdk-js/platform/contracts/contracts.md
- docs/sdk-js/platform/contracts/publish.md
- docs/dapi-client-js/usage/platform/getidentityidbyfirstpublickey.md
- docs/sdk-js/getting-started/quick-start.md
- docs/sdk-js/platform/names/search.md
- docs/sdk-js/getting-started/working-with-multiple-apps.md
- docs/sdk-js/overview.md
- docs/dapi-client-js/usage/dapiclient.md
- docs/dapi-client-js/usage/core/getstatus.md
- docs/sdk-js/usage/dashcore-lib-primitives.md
- docs/sdk-js/wallet/wallet.md
- docs/dapi-client-js/usage/core/subscribetoblockheaderswithchainlocks.md
- docs/sdk-js/platform/names/register.md
- docs/dapi-client-js/usage/core/getblockbyheight.md
- docs/dapi-client-js/quick-start.md
- docs/sdk-js/examples/sign-and-verify-messages.md
- docs/sdk-js/platform/documents/broadcast.md
- docs/dapi-client-js/usage/platform/getdocuments.md
- docs/dapi-client-js/usage/core/core.md
- docs/dapi-client-js/usage/core/getblockhash.md
- docs/sdk-js/platform/contracts/history.md
- docs/sdk-js/platform/identities/credit-withdrawal.md
- docs/sdk-js/wallet/signing-encrypt.md
- docs/dapi-client-js/usage/platform/getidentitybyfirstpublickey.md
- docs/sdk-js/platform/identities/credit-transfer.md
- docs/sdk-js/platform/identities/update.md
- docs/sdk-js/platform/documents/create.md
- docs/sdk-js/getting-started/getting-started.md
- docs/sdk-js/getting-started/dash-platform-applications.md
- docs/dapi-client-js/usage/platform/platform.md
- docs/sdk-js/platform/documents/documents.md
- docs/sdk-js/examples/receive-money-and-check-balance.md
- docs/sdk-js/examples/generate-a-new-mnemonic.md
- docs/sdk-js/examples/use-different-account.md
- docs/sdk-js/platform/contracts/create.md
- docs/sdk-js/getting-started/with-typescript.md
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
sdk-js/anddapi-client-js/documentation sections (replaced by evo-sdk tutorials)source-code.mdpagedocs/index.mdtoctree referencesPreview build: https://dash-docs-platform--136.org.readthedocs.build/en/136/
Summary by CodeRabbit