Introduce the ENSDb Interactive Playground to ENSNode Docs - #2321
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
|
Caution Review failedAn error occurred during the review process. Please try again later. ✨ 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 |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
Adds a new ENSNode docs page under Integrate → ENS Unigraph SQL to embed the ENSDb Interactive Playground (read-only snapshot) for exploring the ENS Unigraph via SQL, and updates the environment switch workflow to route Traefik traffic to the new ensdb-playground service.
Changes:
- Added an “ENSDb Interactive Playground” docs page with an embedded iframe to
ensdb-playground.ensnode.io. - Updated Integrate sidebar navigation to include the new playground page.
- Updated docs frontmatter to dock the sidebar on the Unigraph schema reference page; updated the deploy switch workflow to switch the playground router.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx | Docks the sidebar for the long schema reference page. |
| docs/ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdx | New docs page describing/embedding the ENSDb interactive playground. |
| docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.ts | Adds the new playground page to the Integrate sidebar navigation. |
| .github/workflows/deploy_switch_ensnode_environment.yml | Switches Traefik router service mapping for the ENSDb playground during env promotion. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/unigraph/interactive-playground.mdx`:
- Line 18: The ENSNode Schema link on this line uses an absolute localhost URL
(http://localhost:4321/docs/services/ensdb/concepts/database-schemas#ensnode-schema)
which will not work in production. Replace this absolute URL with a relative
link to match the pattern of the preceding ENSDb Writer Schema link, changing it
to start with `/docs/services/ensdb/concepts/database-schemas#ensnode-schema`
instead of the full localhost URL.
🪄 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: 8bec0cb2-6460-40fa-af0a-b04cfc121b75
📒 Files selected for processing (4)
.github/workflows/deploy_switch_ensnode_environment.ymldocs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdxdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx
Greptile SummaryThis PR adds a new "ENSDb Interactive Playground" documentation page under the Integrate → ENS Unigraph SQL section, embedding a read-only Drizzle Gateway iframe so users can explore the ENS Unigraph data model without deploying their own ENSNode instance. It also wires up the corresponding blue/green switch step in the deployment workflow and adds
Confidence Score: 5/5Safe to merge — changes are limited to a new documentation page, a sidebar entry, a one-line workflow addition, and a frontmatter flag. All internal links in the new MDX page use relative paths (the previously flagged localhost URL is not present in the current diff). The sidebarDocked frontmatter property is validated by its use in existing pages and the content schema. The workflow addition is minimal and the team has already confirmed the intentional absence of an lb-header-* counterpart for this service. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User visits ENSNode Docs] --> B[Integrate → ENS Unigraph SQL]
B --> C[Interactive Playground page]
C --> D{Choose view}
D -->|Fullscreen| E[LinkCard → ensdb-playground.ensnode.io]
D -->|Embedded| F[iframe → ensdb-playground.ensnode.io]
F --> G[Drizzle Gateway]
G --> H[(Read-only ENSDb Snapshot\nENSNode Alpha v1.16.0)]
subgraph Blue/Green Deployment
I[deploy_switch_ensnode_environment.yml]
I -->|redis-cli SET| J[ensdb-playground-router\n→ TARGET_ENVIRONMENT-ensdb-playground]
end
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
A[User visits ENSNode Docs] --> B[Integrate → ENS Unigraph SQL]
B --> C[Interactive Playground page]
C --> D{Choose view}
D -->|Fullscreen| E[LinkCard → ensdb-playground.ensnode.io]
D -->|Embedded| F[iframe → ensdb-playground.ensnode.io]
F --> G[Drizzle Gateway]
G --> H[(Read-only ENSDb Snapshot\nENSNode Alpha v1.16.0)]
subgraph Blue/Green Deployment
I[deploy_switch_ensnode_environment.yml]
I -->|redis-cli SET| J[ensdb-playground-router\n→ TARGET_ENVIRONMENT-ensdb-playground]
end
Reviews (5): Last reviewed commit: "Apply PR feedback" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdx (1)
18-18:⚠️ Potential issue | 🔴 Critical | ⚡ Quick winFix absolute localhost URL that breaks in production.
Line 18 contains an absolute URL to
http://localhost:4321/...which will send users to their own localhost in production instead of the intended documentation path. The preceding link to "ENSDb Writer Schema" correctly uses a relative/docs/...path; apply the same pattern here.🔗 Proposed fix
-2. Browse tables in the [ENSDb Writer Schema](/docs/services/ensdb/concepts/database-schemas#ensdb-writer-schema) (named as `alpha` in this example ENSDb instance) and the [ENSNode Schema](http://localhost:4321/docs/services/ensdb/concepts/database-schemas#ensnode-schema) (always named as `ensnode`). +2. Browse tables in the [ENSDb Writer Schema](/docs/services/ensdb/concepts/database-schemas#ensdb-writer-schema) (named as `alpha` in this example ENSDb instance) and the [ENSNode Schema](/docs/services/ensdb/concepts/database-schemas#ensnode-schema) (always named as `ensnode`).🤖 Prompt for 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. In `@docs/ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdx` at line 18, The absolute localhost URL in the ENSNode Schema link uses http://localhost:4321/docs/services/ensdb/concepts/database-schemas#ensnode-schema which will break in production. Replace this absolute localhost URL with a relative path using the same format as the preceding ENSDb Writer Schema link, converting it to /docs/services/ensdb/concepts/database-schemas#ensnode-schema so the link works consistently across all environments.
🤖 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.
Outside diff comments:
In
`@docs/ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdx`:
- Line 18: The absolute localhost URL in the ENSNode Schema link uses
http://localhost:4321/docs/services/ensdb/concepts/database-schemas#ensnode-schema
which will break in production. Replace this absolute localhost URL with a
relative path using the same format as the preceding ENSDb Writer Schema link,
converting it to /docs/services/ensdb/concepts/database-schemas#ensnode-schema
so the link works consistently across all environments.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 5df9a5f8-3f76-4526-96cd-e3e2d6f6161b
📒 Files selected for processing (3)
docs/ensnode.io/config/integrations/starlight/sidebar-topics/integrate.tsdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdxdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/schema-reference.mdx
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@tk-o Looks nice 👍 Shared a few small suggestions. Please take the lead to merge when ready
|
|
||
| ::: | ||
|
|
||
| <iframe title="ENSDb Interactive Playground" loading="lazy" src="https://ensdb-playground.ensnode.io/" width="100%" height="100%" style="min-height: 800px;" /> |
There was a problem hiding this comment.
Suggest to also add a "card" to open this interactive playground in a fullscreen view. This would open to https://ensdb-playground.ensnode.io/ in a new tab without any iframe.
Co-authored-by: lightwalker.eth <126201998+lightwalker-eth@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/unigraph/interactive-playground.mdx`:
- Line 32: The current implementation only includes an embedded iframe with a
constrained minimum height of 800px, which limits the user experience for
exploratory SQL sessions. Add a card component (or call-to-action element)
alongside or as an alternative to the existing iframe that links to
https://ensdb-playground.ensnode.io/ and opens in a new tab, allowing users to
access the playground in fullscreen without the iframe height restrictions. This
can be implemented as an additional MDX component or card element in the
interactive-playground.mdx file.
🪄 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: de0f3b00-2b98-4440-9aa0-7e59f98a9d43
📒 Files selected for processing (1)
docs/ensnode.io/src/content/docs/docs/integrate/unigraph/interactive-playground.mdx
7a83fd1 to
d83a08e
Compare
d83a08e to
6585099
Compare
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)