docs: v3.1 release cleanup (state-transition dedup, deprecated DAPI removal, build-warning fixes)

[thephez]

Summary

Generic v3.1 release housekeeping that didn't fit any single feature theme:

• State transition page dedup. Replace the one-cell type discriminator (twenty <br>-separated links in a single cell) with a proper 3-column catalog table, and delete the seven type-0–8 detail sections that duplicate the canonical wire-format tables on identity.md / data-contract.md. Batch and Masternode Vote stay inline because they have no dedicated feature page.
• Drop deprecated DAPI endpoints. Remove getIdentities and getIdentitiesByPublicKeyHashes from dapi-endpoints-platform-endpoints.md. Both RPCs were removed for v1.0.0.
• Demote stale bold annotations on the DAPI overview.
• Clean up build warnings. Fix broken intra-doc cross-references and silence Pygments lexer errors on placeholder JSON blocks by converting affected fences to code-block directives with :force:.
• Minor formatting nits across data-contracts.md, query-syntax.md, data-contract-document.md, and one example-app page.

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

Summary by CodeRabbit

• New Features

  • Added Shielded Pool explanation and protocol reference documentation
  • Added Proofs explanation documentation
  • Documented aggregate queries (count, sum, average) for v3.1.0

• Documentation

  • Clarified Platform address bech32m encoding documentation
  • Expanded DAPI endpoint documentation for getDocuments with aggregate query examples
  • Enhanced state transition signing methods reference
  • Updated protocol constants and limits
  • Expanded sidebar navigation with new example apps and topics

• Chores

  • Updated build configuration to exclude release documentation

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR consolidates Dash Platform v3.1 documentation updates: adds new conceptual pages explaining proofs and shielded pool cryptography, updates protocol reference for shielded state transitions and aggregate query capabilities, documents the new DAPI v3.1 endpoint surface with aggregate query modes, wires navigation, and establishes contributor and release process guidance.

Changes

Dash Platform v3.1 Documentation Consolidation

Layer / File(s)	Summary
Conceptual documentation: proofs and shielded pool docs/explanations/proofs.md, docs/explanations/shielded-pool.md	New proofs.md explains two-layer proof architecture, verification flows, supported proof targets (identities, contracts, documents, tokens, state), and asset lock proof types. New shielded-pool.md describes Orchard notes/commitments, nullifiers, encrypted notes, five transition types, usage guidance, and privacy limitations.
Protocol reference: shielded transitions and signing docs/protocol-ref/shielded-pool.md, docs/protocol-ref/state-transition.md	shielded-pool.md documents Orchard bundle structure (actions, anchors, proof, binding signature), platform sighash binding formula, five transition types with field definitions, signing semantics (Orchard vs. transparent signatures), and DAPI query endpoints. State transition reference reorganized with consolidated type table, expanded signing method table including shielded categories, new "Signing Shielded Transitions" section clarifying signature field omission and Orchard authorization.
Protocol reference: constants, limits, and address encoding docs/protocol-ref/protocol-constants.md, docs/protocol-ref/address-system.md	Protocol constants: max shielded transition actions reduced to 16, max asset-lock transaction inputs added (100), bech32m HRP/type-bytes updated, asset lock transaction limits added. Address system: bech32m encoding clarified with 21-byte payload structure, type-byte/bincode variant distinction documented with decoding-context warning.
Data contract document reference: aggregate query flags docs/protocol-ref/data-contract-document.md, docs/protocol-ref/data-contract.md	New "Aggregate Query Flags" section defines documentsCountable/rangeCountable, documentsSummable/rangeSummable, documentsAverageable/rangeAverageable with validation/compatibility constraints and average desugaring rules. Code blocks converted to MyST directives. Cross-reference added to data-contract summary page.
DAPI endpoint documentation: v3.1 getDocuments surface and aggregates docs/reference/dapi-endpoints-platform-endpoints.md, docs/reference/dapi-endpoints.md	getDocuments reworked for v3.1: documents typed v1 envelope with where_clauses, order_by, aggregate selects vs. legacy v0 CBOR fetch. Adds "Fetch documents", "Count", "Sum", "Average" subsections with mode-specific request examples, response shapes, gRPCurl payloads. Deprecated getIdentities endpoints removed. Summary page updated to mark getDocuments as "Updated in v3.1.0".
Query syntax reference: aggregate queries and formatting docs/reference/query-syntax.md	New "Aggregate Queries" section describes select/groupBy modes, result mapping table, required schema flags, numeric precision (SUM/AVG), and unsupported features. Code block examples converted to Sphinx directives with :force: for consistent rendering across operator types.
Navigation wiring: toctrees and sidebar entries docs/index.md, _templates/sidebar-main.html	docs/index.md toctrees: explanations/shielded-pool added to Explanations; protocol-ref/shielded-pool added to Platform Protocol Reference. Sidebar template: new "Example apps" entries (Dashnote, DashMint Lite, Dashnote Lite, DashProof Lite); "Proofs" and "Shielded Pool" links under Explanations; "Shielded Pool" link under Platform Protocol Reference.
Documentation process: contributor guidance and build configuration CLAUDE.md, RELEASE.md, conf.py	CLAUDE.md: new "Adding a new doc page" and "DAPI endpoint reference" guidance sections covering toctree registration, sidebar syncing, proto-driven endpoint updates, description sync, version annotation, and reference to release workflow. RELEASE.md: release checklist for DAPI endpoint review (proto diff → update detail/overview pages with annotation changes → refresh testnet examples) and manual "previous version" link updates. conf.py: RELEASE.md added to exclude_patterns.
Cleanup: code formatting, deprecated content removal, and link standardization docs/explanations/platform-protocol-data-trigger.md, docs/reference/data-contracts.md, docs/tutorials/dashmint-lab.md, docs/tutorials/node-setup/connect-to-a-network-dash-masternode.md, docs/reference/dapi-endpoints.md	Removes "Feature flags" system contract row and wizard output. data-contracts.md reformats code block examples to MyST directives. dashmint-lab.md converts NFT link to Sphinx {ref} cross-reference. node-setup.md removes Feature Flags output lines. dapi-endpoints.md normalizes unrelated endpoint version emphasis (bold to italic).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• dashpay/docs-platform#149: Both update DAPI getDocuments v3.1 documentation with aggregate-query references, matching documentation workflow guidance in CLAUDE.md/RELEASE.md.
• dashpay/docs-platform#150: Both add/wire shielded-pool documentation pages, update state-transition signing/types, and adjust related protocol constants and navigation.
• dashpay/docs-platform#147: Both add "example apps" sidebar navigation entries (DashMint Lite, DashProof Lite, Dashnote variants) and corresponding toctree wiring.

Poem

🐰 A scholar's sprint through docs so bright,
With proofs and pools and aggregates in sight,
State transitions signed, constants clarified—
v3.1's story, no longer denied!

🚥 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 accurately summarizes the three main themes of the PR: v3.1 release cleanup, state-transition deduplication, deprecated DAPI removal, and build-warning fixes. It directly reflects the actual changes across 23 documentation files.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[thephez]

@coderabbitai full review

[coderabbitai]

✅ Actions performed

Full review triggered.