Skip to content

Add HyperSync preset queries doc#635

Merged
moose-code merged 1 commit intomainfrom
codex/add-missing-preset-queries-to-documentation
Jun 12, 2025
Merged

Add HyperSync preset queries doc#635
moose-code merged 1 commit intomainfrom
codex/add-missing-preset-queries-to-documentation

Conversation

@moose-code
Copy link
Member

@moose-code moose-code commented May 20, 2025

Summary

  • document preset query helpers
  • include new page in the sidebar
  • document all preset query functions

Testing

  • git status --short

Summary by CodeRabbit

  • Documentation
    • Added a new guide detailing preset query helper functions available in HyperSync client libraries, including usage examples and descriptions of each preset.
    • Updated the documentation sidebar to include the new "HyperSync Presets" section for easier navigation.

@vercel
Copy link

vercel bot commented May 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
envio-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 20, 2025 9:00am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 20, 2025

Walkthrough

A new documentation file describing HyperSync preset query helper functions was added. The sidebar configuration was updated to include this new documentation entry, ensuring it appears in the navigation structure between existing related topics. No code or API changes were made; all updates are documentation and configuration only.

Changes

File(s) Change Summary
docs/HyperSync/hypersync-presets.md Added documentation detailing preset query helpers for HyperSync clients, including usage examples.
sidebarsHyperSync.js Updated sidebar configuration to add "hypersync-presets" to the HyperSync documentation navigation.

Poem

In docs we trust, a new guide appears,
Presets for queries, to banish all fears.
The sidebar now gleams with a shiny new link,
Helping explorers find answers in a blink.
Hippity-hop through the docs you go—
HyperSync helpers, now easy to know!
🐇📚✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@moose-code
Copy link
Member Author

@JasoonS previously there was no mention about simple hypersync presets.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
docs/HyperSync/hypersync-presets.md (3)

33-34: Add missing comma for clarity.
Consider updating the sentence to improve readability:

- Returns every block in the range along with only the transaction hashes.
+ Returns every block in the range, along with only the transaction hashes.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~34-~34: Possible missing comma found.
Context: ...k, to_block)` Returns each block in the range along with only the transaction hashes....

(AI_HYDRA_LEO_MISSING_COMMA)


45-46: Reduce repetitive phrasing.
To avoid starting multiple lines with "Fetches", you could reword this line, for example:

- Fetches every log across the specified blocks.
+ Retrieves every log across the specified blocks.

48-50: Avoid repeated sentence openers.
Similarly, rephrase to maintain variety, e.g.:

- Fetches logs for the specified event signature over the block range.
+ Retrieves logs matching the specified event signature over the block range.
🧰 Tools
🪛 LanguageTool

[style] ~48-~48: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...event_signature, from_block, to_block)` Fetches logs for the specified event signature ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 868521b and 00f6ba3.

📒 Files selected for processing (2)
  • docs/HyperSync/hypersync-presets.md (1 hunks)
  • sidebarsHyperSync.js (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/HyperSync/hypersync-presets.md

[uncategorized] ~34-~34: Possible missing comma found.
Context: ...k, to_block)` Returns each block in the range along with only the transaction hashes....

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~48-~48: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...event_signature, from_block, to_block)` Fetches logs for the specified event signature ...

(ENGLISH_WORD_REPEAT_BEGINNING_RULE)

🔇 Additional comments (8)
docs/HyperSync/hypersync-presets.md (7)

8-12: Introduction is clear and concise.
The opening section effectively explains the purpose of these presets and how to use them with the client.


14-16: Section header aligns with style guidelines.
The “Available Presets” heading and subsequent subsection title follow existing patterns and are well-structured.


19-31: Example for preset_query_blocks_and_transactions is well-formed.
The Python snippet demonstrates usage clearly, including async setup and result inspection.


36-38: Preset description is accurate.
The preset_query_get_logs heading and explanation correctly summarize its purpose.


39-43: Code snippet usage is consistent.
The example shows how to pass the preset to client.get and is formatted in line with other Python blocks.


51-53: Cross-language links are helpful.
The pointers to the Python and Node.js example repos provide valuable context for users of other languages.


1-6:

Details

✅ Verification successful

Verify front matter slug consistency.
The slug: /hypersync-presets entry should match the format used by existing HyperSync docs (often without a leading slash). Please confirm that this aligns with other pages' front matter or adjust accordingly.


🏁 Script executed:

#!/bin/bash
# Verify slug formats across HyperSync docs
rg -A1 "^slug:" -n docs/HyperSync

Length of output: 1628


Slug format is consistent across HyperSync docs
All existing HyperSync pages use a leading slash in their slug front-matter. The entry in docs/HyperSync/hypersync-presets.md (slug: /hypersync-presets) matches the project convention—no change needed.

sidebarsHyperSync.js (1)

7-9: Sidebar entry correctly added.
The new "hypersync-presets" item matches the documentation file’s id and is placed logically between "hypersync-query" and "hypersync-curl-examples".

@moose-code moose-code merged commit 92a72c3 into main Jun 12, 2025
3 checks passed
@moose-code moose-code deleted the codex/add-missing-preset-queries-to-documentation branch June 12, 2025 11:28
@DenhamPreen DenhamPreen mentioned this pull request Jul 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants