docs: 1.15.x#2225
Merged
Merged
Conversation
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Contributor
|
Warning Review limit reached
More reviews will be available in 52 minutes and 51 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (15)
📝 WalkthroughWalkthroughThis PR consolidates the ENS Omnigraph snapshot infrastructure from per-version directories to a single vendored snapshot, removes the ACTIVE_OMNIGRAPH_VERSION constant, updates all example applications to v1.15.1 with canonical.name.beautified adoption for domain display, simplifies documentation by removing versioned walkthroughs and using snapshot-based version pinning, and adds snapshot validation tests. ChangesOmnigraph snapshot and canonical name refactoring
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related issues
Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 3❌ Failed checks (1 warning, 2 inconclusive)
✅ Passed checks (2 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
This PR updates the docs + example apps to align with the 1.15.1 Omnigraph schema and simplifies the docs’ “vendored snapshot” strategy by removing per-version walkthroughs/snapshots in favor of a single production-locked snapshot on main. It also updates the docs and examples to use CanonicalName.beautified directly and explains the “BeautifiedName” concept in walkthroughs.
Changes:
- Bump
enssdk/enskitversions used by the example apps to1.15.1and update example queries to usecanonical { name { beautified } }. - Replace multi-version Omnigraph docs snapshot infrastructure (
ACTIVE_OMNIGRAPH_VERSION+versions/*) with a single vendored snapshot (schema.graphql,examples.json,responses.json,snapshot.json) plus updated tests. - Update integration docs pages to render a single (production-locked) walkthrough and add “BeautifiedName” notes to relevant walkthroughs.
Reviewed changes
Copilot reviewed 39 out of 45 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-lock.yaml | Updates lockfile for example app dependency bumps to enssdk@1.15.1 / enskit@1.15.1. |
| examples/omnigraph-graphql-example/src/index.ts | Switches example query/output to use canonical.name.beautified instead of name. |
| examples/enssdk-example/src/index.ts | Updates Omnigraph fragment + formatting to use canonical.name.beautified and removes manual beautification. |
| examples/enssdk-example/package.json | Bumps enssdk dependency to 1.15.1. |
| examples/enskit-react-example/src/SearchView.tsx | Migrates search to DomainsNameFilter.starts_with and displays canonical.name.beautified. |
| examples/enskit-react-example/src/DomainView.tsx | Updates fragment and parent/subdomain rendering to use canonical.name.beautified. |
| examples/enskit-react-example/src/App.tsx | Updates the hardcoded example account address used in the app. |
| examples/enskit-react-example/src/AccountView.tsx | Displays owned domains using canonical.name.beautified instead of name. |
| examples/enskit-react-example/package.json | Bumps enskit and enssdk dependencies to 1.15.1. |
| docs/ensnode.io/src/lib/examples/omnigraph/build-integration-snippets.ts | Reads sdkVersion from the new vendored snapshot.json instead of ACTIVE_OMNIGRAPH_VERSION. |
| docs/ensnode.io/src/lib/examples/omnigraph/build-integration-snippets.test.ts | Updates tests to validate snippets against the vendored snapshot JSON files. |
| docs/ensnode.io/src/data/omnigraph-examples/versions/v1.15.1/schema.graphql | Removes versioned schema snapshot file (replaced by a single vendored schema). |
| docs/ensnode.io/src/data/omnigraph-examples/versions/v1.15.0/snapshot.json | Removes versioned snapshot metadata (replaced by a single vendored snapshot). |
| docs/ensnode.io/src/data/omnigraph-examples/versions/v1.15.0/examples.json | Removes versioned example queries snapshot (replaced by a single vendored examples.json). |
| docs/ensnode.io/src/data/omnigraph-examples/versions/v1.13.1/snapshot.json | Removes older versioned snapshot metadata. |
| docs/ensnode.io/src/data/omnigraph-examples/versions/v1.13.1/schema.graphql | Removes older versioned schema snapshot. |
| docs/ensnode.io/src/data/omnigraph-examples/versions/v1.13.1/examples.json | Removes older versioned example queries snapshot. |
| docs/ensnode.io/src/data/omnigraph-examples/versions.test.ts | Replaces per-version snapshot validation test with single-snapshot validation. |
| docs/ensnode.io/src/data/omnigraph-examples/types.ts | Updates SnapshotExample docs comment to reflect the new vendored snapshot layout. |
| docs/ensnode.io/src/data/omnigraph-examples/snapshot.test.ts | New test validating vendored examples.json queries against vendored schema.graphql. |
| docs/ensnode.io/src/data/omnigraph-examples/snapshot.json | New single “vendored snapshot” metadata file used by docs. |
| docs/ensnode.io/src/data/omnigraph-examples/schema.graphql | New single vendored Omnigraph schema SDL used for docs + explorer. |
| docs/ensnode.io/src/data/omnigraph-examples/examples.ts | Refactors example loading to use the vendored examples.json + responses.json. |
| docs/ensnode.io/src/data/omnigraph-examples/examples.json | New single vendored Omnigraph example query set. |
| docs/ensnode.io/src/data/omnigraph-examples/active.ts | Removes the old ACTIVE_OMNIGRAPH_VERSION mechanism. |
| docs/ensnode.io/src/content/docs/docs/integrate/integration-options/omnigraph-graphql-api.mdx | Switches to a single walkthrough file and updates the “production-locked” explanation. |
| docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/index.mdx | Switches to a single walkthrough file and updates the “production-locked” explanation. |
| docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/index.mdx | Switches to a single walkthrough file and updates the “production-locked” explanation. |
| docs/ensnode.io/src/content/docs/docs/integrate/index.mdx | Switches to a single quickstart walkthrough file and updates the “production-locked” explanation. |
| docs/ensnode.io/src/components/walkthroughs/quickstart/v1.13.1.mdx | Removes old versioned quickstart walkthrough. |
| docs/ensnode.io/src/components/walkthroughs/quickstart.mdx | Adds a “BeautifiedName” note in the unified quickstart walkthrough. |
| docs/ensnode.io/src/components/walkthroughs/omnigraph-graphql-api/v1.13.1.mdx | Removes old versioned Omnigraph walkthrough. |
| docs/ensnode.io/src/components/walkthroughs/omnigraph-graphql-api.mdx | Adds a “BeautifiedName” note in the unified Omnigraph walkthrough. |
| docs/ensnode.io/src/components/walkthroughs/enssdk/v1.13.1.mdx | Removes old versioned enssdk walkthrough. |
| docs/ensnode.io/src/components/walkthroughs/enssdk.mdx | Updates install command to enssdk@1.15.1 and adds a “BeautifiedName” note. |
| docs/ensnode.io/src/components/walkthroughs/enskit/v1.13.1.mdx | Removes old versioned enskit walkthrough. |
| docs/ensnode.io/src/components/walkthroughs/enskit.mdx | Updates install command to enskit@1.15.1 / enssdk@1.15.1 and adds a “BeautifiedName” note. |
| docs/ensnode.io/src/components/organisms/OmnigraphSchemaDocExplorer.tsx | Uses vendored schema.graphql directly (no runtime version selection). |
| docs/ensnode.io/src/components/molecules/HostedInstanceSdkVersionWarning.astro | Uses vendored snapshot.json for the pinned SDK version message. |
| docs/ensnode.io/src/components/molecules/HostedEnsNodeInstance.astro | Displays hosted ENSNode version from the vendored snapshot.json. |
| docs/ensnode.io/scripts/snapshot-omnigraph-version.mts | Refactors snapshot script to overwrite the single vendored snapshot instead of writing per-version directories. |
| docs/ensnode.io/scripts/fetch-omnigraph-example-responses.mts | Refactors response fetcher to write into the single vendored snapshot location. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Greptile SummaryThis PR simplifies the documentation versioning workflow by replacing the multi-version snapshot system (per-version files under
Confidence Score: 5/5Safe to merge — this is a documentation restructuring and SDK version bump with no runtime logic changes. All changes are documentation content, build-time data files, and example apps. The core simplification (single vendored snapshot replacing the per-version directory) is internally consistent: snapshot.sdkVersion now drives install-command snippets and the SDK version warning, which is more accurate than the old ACTIVE_OMNIGRAPH_VERSION.replace approach. The new snapshot.test.ts validates all 18 example queries against the vendored schema, providing a regression net. No files require special attention. Important Files Changed
Reviews (6): Last reviewed commit: "docs: remove unused starlight imports (l..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Member
Author
|
@greptile review |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
lightwalker-eth
approved these changes
May 29, 2026
Member
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@shrugs Looks good! 🚀 Please take the lead to merge when ready 👍
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 49 out of 55 changed files in this pull request and generated no new comments.
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)
docs/ensnode.io/src/lib/examples/omnigraph/build-integration-snippets.test.ts:27
- The integration-snippet typechecking fixtures below are no longer valid against the current Omnigraph schema (e.g. they query
Domain.name, and one fixture callsQuery.domainswithout the requiredwhereargument). Because these fixtures are passed through gql.tada inexpectIntegrationSnippetTypechecks(...), they will fail the test suite unless updated to usecanonical { name { ... } }and validdomains(where: ...)arguments.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
mainusing the vendored production schema in the docs and the production version number in the example apps. when we want to prep updates to the docs that are for a future version, we'll collectively maintain a pr (ensuring that it's always rebased onto main) with the updates which we can merge in unison with the promotion of the new version to production.BeautifiedNamenotes to walkthroughs to explain the beautified name concept