Add custom event names docs

[moose-code]

Summary

• document HyperIndex feature allowing custom names for events

Testing

• yarn build (fails: package not in lockfile)

Summary by CodeRabbit

• Documentation
  • Added a new subsection explaining how to assign custom event names in the configuration file, including use cases and example YAML configuration.

[vercel]

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 8:42am

[coderabbitai]

Walkthrough

The documentation for the config.yaml configuration file was updated to include a new subsection about assigning custom event names. This new content explains the use of the name attribute in event definitions, provides context for when custom names are helpful, and includes an illustrative YAML example.

Changes

File(s)	Change Summary
docs/HyperIndex/Guides/configuration-file.mdx	Added a subsection under "Events Selection" explaining custom event names, including usage and examples.

Poem

In the garden of config, new names now bloom,
Events with twin faces, no longer spell doom.
Custom labels assigned, as clear as can be,
YAML lines dancing, in sweet clarity.
A hop and a skip—oh, what a delight!
Docs growing richer, from morning to night.
🐇✨

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.

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

docs/HyperIndex/Guides/configuration-file.mdx (3)

102-104: Tone and Style Consistency
Consider replacing “This is handy when” with more neutral phrasing like “Use this option when” to match the formal tone used elsewhere in the guide.

---

106-112: Wrap in Admonition for Visibility
To make this feature stand out, wrap the explanatory text and YAML snippet in an :::tip or :::note block (similar to the proxy contract tip). For example:

:::tip Custom Event Names
You can assign custom names to events in `config.yaml`…

---

106-112: Example Clarification
Add a brief sentence below the YAML snippet to note that the name attribute overrides the default event identifier in handlers or generated code, so users immediately understand its effect.

📜 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 a5df2f5.

📒 Files selected for processing (1)

• docs/HyperIndex/Guides/configuration-file.mdx (1 hunks)

🔇 Additional comments (1)

docs/HyperIndex/Guides/configuration-file.mdx (1)

100-100: Heading Level Confirmation
The #### Custom Event Names heading correctly uses a level-4 heading under the “Events Selection” section, maintaining the established structure.

[DZakh]

Nice 👍