Skip to content

Querying Data pages: move operator/property reference before examples #34

@marcos-golem

Description

@marcos-golem

Both Querying Data reference pages — TypeScript SDK and JSON-RPC — currently open with full worked examples before listing the available operators and their accepted properties. External DX feedback confirms the pattern breaks the mid-task lookup flow: a builder checking whether gte accepts a BigInt has to scroll past an entire example block to find the answer, then scroll back.

Restructure each page to the standard reference convention: operator/property table first, worked examples at the bottom.

TypeScript SDK page

  1. Move the operator and property reference table to the top of the content area, immediately after any one-line intro sentence.
  2. Move all code examples (including full query construction walkthroughs) to an "Examples" section at the end.

JSON-RPC page

Apply the same order: operator/property reference → examples.

No content needs to be removed. This is a reorder only. Confirm with the docs lead whether the two pages share a component or are authored independently before touching markup.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No fields configured for Task.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions