feat(docs): add planned integrations for ENSDb snapshots, CLI, and webhooks#2107
Merged
Conversation
…bhooks - Introduced new sidebar topics for "ENSDb snapshots & CLI" and "Webhooks & events" in integration documentation. - Added a new component for ENSDb snapshots teaser to highlight benefits. - Created detailed documentation for both planned features, outlining their value propositions and use cases. - Updated existing integration options to reference the new features, enhancing the overall documentation structure.
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds documentation and sidebar navigation for two planned features: ENSDb snapshots with ChangesPlanned Features Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds new “planned feature” documentation to the docs site to better surface upcoming ENSDb snapshot/CLI capabilities and a new ENSEngine service concept (webhooks/events), and wires these pages into the docs navigation.
Changes:
- Added new planned-feature teaser docs for ENSDb snapshots & CLI and Webhooks & events, plus a new ENSEngine service overview page.
- Updated Services / Integrate navigation (sidebars + index pages) to include the new planned topics.
- Introduced a reusable
EnsDbSnapshotsTeasercomponent and embedded it in relevant docs.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ensnode.io/src/content/docs/docs/services/index.mdx | Mentions planned ENSEngine and links to its planned docs page from Services overview. |
| docs/ensnode.io/src/content/docs/docs/services/ensengine/index.mdx | New planned-service overview page describing ENSEngine positioning and intent. |
| docs/ensnode.io/src/content/docs/docs/services/ensdb/index.mdx | Adds a “What’s next” aside pointing readers to snapshots/CLI teaser. |
| docs/ensnode.io/src/content/docs/docs/self-host/index.mdx | Adds a planned “faster paths” section and embeds snapshots teaser component. |
| docs/ensnode.io/src/content/docs/docs/reference/roadmap.mdx | Adds a roadmap section describing ENSDb snapshots/CLI goals and links to teaser. |
| docs/ensnode.io/src/content/docs/docs/integrate/webhooks-and-events.mdx | New planned “webhooks & events” teaser page describing problem/value props. |
| docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdx | Adds tip block referencing planned snapshots/CLI as a future power-path. |
| docs/ensnode.io/src/content/docs/docs/integrate/index.mdx | Adds a new bullet linking to planned snapshots/CLI page from Integrate index. |
| docs/ensnode.io/src/content/docs/docs/integrate/ensdb-snapshots-and-cli.mdx | New planned snapshots/CLI teaser page + embeds snapshots teaser component. |
| docs/ensnode.io/src/components/molecules/EnsDbSnapshotsTeaser.astro | New reusable CardGrid teaser component describing snapshots/CLI benefits. |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/services.ts | Adds ENSEngine entry to Services sidebar (with “Planned” badge). |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts | Adds planned “ENSDb snapshots & CLI” and “Webhooks & events” to Integrate sidebar. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Greptile SummaryThis docs-only PR adds planned-feature documentation for two upcoming ENSNode capabilities —
Confidence Score: 5/5Documentation-only change adding planned-feature pages; no runtime code is modified. All link targets introduced in this PR resolve to real pages (either pre-existing or added in this same commit), sidebar entries now use the correct No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
subgraph new_pages [New Pages]
ensdb_cli["ensdb-cli & ENSDb snapshots\n(integration-options/ensdb-cli.mdx)"]
ensengine_int["ENSEngine Integration\n(integration-options/ensengine.mdx)"]
ensengine_svc["ENSEngine Service Overview\n(services/ensengine/index.mdx)"]
teaser["EnsDbSnapshotsTeaser.astro\n(reusable component)"]
end
subgraph updated_pages [Updated/Cross-linked Pages]
integrate_idx["integrate/index.mdx"]
ensdb_int["integration-options/ensdb.mdx"]
int_options["integration-options/index.mdx"]
roadmap["reference/roadmap.mdx"]
selfhost["self-host/index.mdx"]
ensdb_svc["services/ensdb/index.mdx"]
services_idx["services/index.mdx"]
end
subgraph sidebars [Sidebars]
integrate_ts["integrate.ts sidebar"]
services_ts["services.ts sidebar"]
end
integrate_ts -->|links to| ensdb_cli
integrate_ts -->|links to| ensengine_int
services_ts -->|links to| ensengine_svc
integrate_idx -->|tip links to| ensdb_cli
ensdb_int -->|tip links to| ensdb_cli
int_options -->|cards link to| ensdb_cli
int_options -->|cards link to| ensengine_int
roadmap -->|section links to| ensdb_cli
selfhost -->|section links to| ensdb_cli
selfhost -->|embeds| teaser
ensdb_svc -->|aside links to| ensdb_cli
services_idx -->|card links to| ensengine_svc
ensdb_cli -->|embeds| teaser
ensdb_cli <-->|cross-links| ensengine_int
ensengine_int <-->|cross-links| ensengine_svc
Reviews (11): Last reviewed commit: "Merge branch 'main' into coming-soon-doc..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
- Revised titles and descriptions for the ENSDb snapshots and CLI documentation to enhance clarity and consistency. - Ensured all mentions of the CLI are updated to reflect the new terminology and context. - Improved overall documentation structure by refining related content.
Contributor
|
Want your agent to iterate on Greptile's feedback? Try greploops. |
Member
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@djstrong This needs a lot of urgent work.
Member
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@djstrong This needs a lot of urgent work.
Co-authored-by: lightwalker.eth <126201998+lightwalker-eth@users.noreply.github.com>
Co-authored-by: lightwalker.eth <126201998+lightwalker-eth@users.noreply.github.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-cli.mdx`:
- Line 21: Replace the nonstandard spelling "pricy" in the user-facing copy
string ("...without being required to send hundreds of thousands of pricy
RPC-calls yourself.") with the standard spelling "pricey" so the sentence reads
"...without being required to send hundreds of thousands of pricey RPC-calls
yourself."
In
`@docs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensengine.mdx`:
- Around line 64-66: The bullet for "Sync to alternative databases" makes
absolute guarantees ("100% delivery", "strict ordering", "exactly-once");
replace these with qualified, accurate delivery semantics for ENSEngine by
softening claims (e.g., "highly reliable delivery", "strong ordering guarantees
where applicable", "exactly-once semantics through idempotent sinks and
deduplication" or "at-least-once with deduplication") and add a short note about
mechanisms (retries, idempotency, ordering scopes like per-entity/stream) so
adopters understand practical guarantees instead of absolute promises; edit the
bulleted line mentioning ENSEngine to implement this wording change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: f3a8e055-2be8-452b-8960-5f36b9d98e19
📒 Files selected for processing (13)
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/config/integrations/starlight/sidebar-topics/services.tsdocs/ensnode.io/src/components/molecules/EnsDbSnapshotsTeaser.astrodocs/ensnode.io/src/content/docs/docs/integrate/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb-cli.mdxdocs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensdb.mdxdocs/ensnode.io/src/content/docs/docs/integrate/integration-options/ensengine.mdxdocs/ensnode.io/src/content/docs/docs/integrate/integration-options/index.mdxdocs/ensnode.io/src/content/docs/docs/reference/roadmap.mdxdocs/ensnode.io/src/content/docs/docs/self-host/index.mdxdocs/ensnode.io/src/content/docs/docs/services/ensdb/index.mdxdocs/ensnode.io/src/content/docs/docs/services/ensengine/index.mdxdocs/ensnode.io/src/content/docs/docs/services/index.mdx
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
djstrong
changed the title
Resolves conflict in services/index.mdx by taking main's ENSNodeServiceCard layout (with 3D icons) and appending an ENSEngine "Coming soon" card. Also capitalizes "integration quickstart" -> "Integration Quickstart" in the four sidebar/title sites where it appeared (per @lightwalker-eth casing direction): - config/integrations/starlight/sidebar-topics/integrate.ts - content/docs/docs/integrate/integration-options/ensdb-cli.mdx (x2) - content/docs/docs/services/ensengine/index.mdx Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
integration-options/ensdb-cli.mdx) and ENSEngine webhooks/events (integration-options/ensengine.mdx,services/ensengine/index.mdx), each marked with “Coming soon” asides.EnsDbSnapshotsTeaser.astroand wire new pages into Integrate/Services sidebars, integration-options hub, and cross-links from ENSDb, self-host, roadmap, and integrate index.Why
ensdb-cli) and event-driven integration (ENSEngine) before implementation lands.Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)