docs: add query explanation

[thephez]

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

Summary by CodeRabbit

• Documentation
  • New documentation section covering Dash Platform's query capabilities, including query scope, consistency, deterministic results, data proofs for verification, and indexed query requirements
  • Updated documentation navigation to include query documentation reference
  • Added security-related note directing to query capabilities

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation expanded with a new query capabilities guide covering scope, determinism, data proofs, and indexed queries. Cross-references updated in index and existing documentation to point to the new resource.

Changes

Cohort / File(s)	Summary
New Query Capabilities Documentation docs/explanations/query.md	Introduces comprehensive documentation covering Dash Platform query capabilities including query scope (finalized vs. pending state), deterministic results across nodes, data proofs (inclusion/non-inclusion), use cases for proofs, and indexed query requirements with limitations
Documentation Updates docs/explanations/dapi.md	Adds a note block under the Security section directing readers to the Query Capabilities page for additional details
Navigation Index docs/index.md	Adds new explanations/query entry to the Explanations section of the documentation toctree

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• New documentation file introduces detailed explanatory content—verify accuracy and completeness of query capability descriptions
• Cross-reference updates (toctree and note block)—confirm all links are correctly formatted and point to the intended location

Poem

🐰 A guide to queries, now complete,
With proofs and scopes, oh what a treat!
Dash Platform's secrets we now relate—
Indexed and deterministic, truly great! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: add query explanation' accurately describes the main change: adding a new query explanation documentation file.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f0abfda and 12659c0.

📒 Files selected for processing (3)

• docs/explanations/dapi.md (1 hunks)
• docs/explanations/query.md (1 hunks)
• docs/index.md (1 hunks)

🔇 Additional comments (4)

docs/index.md (1)

140-140: Toctree entry is correctly positioned and formatted.

The new explanations/query entry is properly placed in alphabetical order within the Explanations section and follows the consistent formatting of surrounding entries.

docs/explanations/dapi.md (1)

27-30: Note placement and cross-reference are appropriate.

The note is contextually well-placed within the Security section and provides a natural redirect to the new Query Capabilities documentation. The relative path reference is correct.

docs/explanations/query.md (2)

1-61: Documentation content is clear, well-structured, and appropriately scoped.

The new query capabilities guide effectively covers scope (finalized state), determinism, data proofs, and indexed queries with helpful explanations and formatting. The progression from basic concepts (querying state) through advanced features (proofs, indexes) is logical and reader-friendly.

---

62-62: No action needed. The cross-reference is valid and correctly formatted.

The file docs/explanations/platform-protocol-data-contract.md exists in the same directory as query.md, and the relative path ./platform-protocol-data-contract.md#contract-updates correctly points to the "#### Contract updates" section (line 63) in that file. The link is not broken.

Likely an incorrect or invalid review comment.

---

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.}