Skip to content

docs: more improvements in docs examples#2148

Merged
lightwalker-eth merged 5 commits into
mainfrom
ll/docs-examples-improve-02
May 19, 2026
Merged

docs: more improvements in docs examples#2148
lightwalker-eth merged 5 commits into
mainfrom
ll/docs-examples-improve-02

Conversation

@sevenzing
Copy link
Copy Markdown
Member

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

Small fixes in docs


Why

  • Why this change exists. Link to related GitHub issues where relevant.

Testing

  • How this was tested.
  • If you didn't test it, say why.

Notes for Reviewer (Optional)

  • Anything non-obvious or worth a heads-up.

Pre-Review Checklist (Blocking)

  • This PR does not introduce significant changes and is low-risk to review quickly.
  • Relevant changesets are included (or are not required)

@sevenzing sevenzing requested a review from a team as a code owner May 19, 2026 11:31
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 19, 2026

⚠️ No Changeset found

Latest commit: c0f1c4f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
enskit-react-example.ensnode.io Ready Ready Preview, Comment May 19, 2026 9:04pm
ensnode.io Ready Ready Preview, Comment May 19, 2026 9:04pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
admin.ensnode.io Skipped Skipped May 19, 2026 9:04pm
ensrainbow.io Skipped Skipped May 19, 2026 9:04pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 19, 2026

Review Change Stack

Warning

Rate limit exceeded

@lightwalker-eth has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 58 minutes and 19 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 8249d55c-f18b-40e6-9852-d543a38fe2de

📥 Commits

Reviewing files that changed from the base of the PR and between aa9eadf and c0f1c4f.

📒 Files selected for processing (1)
  • docs/ensnode.io/src/components/molecules/OmnigraphAPIExamplePanels.astro
📝 Walkthrough

Walkthrough

This PR updates omnigraph documentation and examples, refactors a URL builder function with proper capitalization, tightens component type contracts, enriches GraphQL response fixtures, and removes an unused package export.

Changes

Omnigraph documentation and API refinements

Layer / File(s) Summary
URL builder function refactoring
docs/ensnode.io/src/lib/playground/utils.ts, docs/ensnode.io/src/components/organisms/OmnigraphAPIExample.astro
Renames exported function buildEnsadminOmnigraphUrl to buildEnsAdminOmnigraphUrl and updates the import and function call in the consuming component.
Component prop type tightening
docs/ensnode.io/src/components/molecules/OmnigraphAPIExamplePanels.astro
Imports ENSNamespaceId type and updates the hostedInstanceNamespace prop from string to the stricter ENSNamespaceId type.
StackBlitz editor load instructions
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/example.mdx, docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/example.mdx
Updates initial load notes to reflect longer client-side npm install time and adds caution callouts about a May 19 StackBlitz embed outage with instructions to use the "Fork on StackBlitz" fallback.
Minor documentation refinements
docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/schema-reference.mdx, docs/ensnode.io/src/content/docs/docs/services/ensrainbow/concepts/creating-files.mdx
Adds article "a" to playground description and changes admonition type from warning to caution in legacy migration sections.
GraphQL response fixtures
docs/ensnode.io/src/data/omnigraph-examples/responses.json
Populates domain-resolver example with full resolver object including records, events, and permissions; reorders find-domains node fields to list registration before name.
Package export cleanup
packages/ensnode-sdk/package.json
Removes the unused ./omnigraph-api/example-queries subpath export from the package exports map.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Suggested labels

docs


🐰 A rabbit's refactor rhyme:
URLs now properly capitalized bright,
Types get stricter, contracts tight,
Fixtures enriched with records galore,
StackBlitz warnings, cautions galore—
Minor updates, all polished right!

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description uses the template structure but lacks substantive content in critical sections like Summary, Why, and Testing, with only placeholder text remaining. Fill in the Summary with 1-3 specific bullets about changes, explain Why these changes were needed with issue links if relevant, and describe Testing methodology or explain why testing was not performed.
Title check ❓ Inconclusive The title 'docs: more improvements in docs examples' is vague and overly generic, using non-descriptive phrasing that doesn't convey the specific changes made. Use a more specific title that describes the primary changes, such as 'docs: fix StackBlitz embed notes and refine type signatures' or similar.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ll/docs-examples-improve-02

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 19, 2026

Greptile Summary

This PR makes several small improvements to the ENSNode docs: fixes a function name casing (buildEnsadminOmnigraphUrlbuildEnsAdminOmnigraphUrl), upgrades a prop type from string to the stricter ENSNamespaceId, adds temporary StackBlitz outage notices, and replaces an empty mock response for the domain-resolver example with real data.

  • utils.ts / OmnigraphAPIExample.astro: Renames buildEnsadminOmnigraphUrl to buildEnsAdminOmnigraphUrl to fix camelCase and updates the sole call site accordingly.
  • package.json (ensnode-sdk): Removes the ./omnigraph-api/example-queries dev export path; the module remains accessible via ./internal and no consumers of the removed path exist in the monorepo.
  • responses.json: Expands the previously null domain-resolver response with real resolver records, events, and permissions data; also reorders name/registration fields in several find-domains entries.

Confidence Score: 5/5

Safe to merge — all changes are documentation and example data with no runtime logic affected.

All changes are confined to docs content, example mock data, a function rename with a single updated call site, a prop type narrowing, and removal of an unused package export path. No application logic, API, or data pipeline is altered.

responses.json — the domain-resolver mock response still lacks the assigned nesting level the example query requires (flagged in prior review thread).

Important Files Changed

Filename Overview
docs/ensnode.io/src/lib/playground/utils.ts Renames exported function to correct camelCase; sole call site updated in the same PR.
docs/ensnode.io/src/components/organisms/OmnigraphAPIExample.astro Updates call site to renamed buildEnsAdminOmnigraphUrl; no other changes.
docs/ensnode.io/src/components/molecules/OmnigraphAPIExamplePanels.astro Tightens prop type from string to ENSNamespaceId, which is correctly re-exported from the SDK index.
packages/ensnode-sdk/package.json Removes unused ./omnigraph-api/example-queries dev export; the module is still accessible via ./internal and no monorepo consumers import the removed path.
docs/ensnode.io/src/data/omnigraph-examples/responses.json Replaces null domain-resolver mock with real data, but the response omits the assigned nesting level that the example query requires (noted in prior review thread).
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/example.mdx Adds StackBlitz outage caution notice and improves first-load instructions; notice lacks a year on the date.
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/example.mdx Same outage notice and first-load text improvements as the enskit example page.
docs/ensnode.io/src/content/docs/docs/services/ensrainbow/concepts/creating-files.mdx Downgrades two admonition types from warning to caution; purely cosmetic/style change.
docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/schema-reference.mdx Minor grammar fix: "in web playground" → "in a web playground".

Reviews (2): Last reviewed commit: "Merge branch 'main' into ll/docs-example..." | Re-trigger Greptile

Comment thread docs/ensnode.io/src/data/omnigraph-examples/responses.json
Copy link
Copy Markdown
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: 3

🤖 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/enskit/example.mdx`:
- Around line 20-22: Update the "StackBlitz embed outage" caution block so the
outage date includes the year: replace the phrase "as of **May 19**" with "as of
**May 19, 2026**" (or the correct year) in the caution block text to make the
date explicit and unambiguous.

In
`@docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/example.mdx`:
- Around line 20-22: Update the caution block titled "StackBlitz embed outage"
so the outage date is unambiguous by replacing the bare "May 19" text with a
full date including year (for example "May 19, 2026"); locate the string
"StackBlitz is having problems with embedded WebContainer projects as of **May
19**" in the file and change it to include the year (e.g., "**May 19, 2026**")
while preserving the surrounding Markdown/caution formatting.

In `@packages/ensnode-sdk/package.json`:
- Around line 20-22: The package.json export removed the subpath
"./omnigraph-api/example-queries", which is a breaking change for consumers;
restore a compatibility export entry for "./omnigraph-api/example-queries" that
points to the previous module (or add a small re-export file like
src/omnigraph-api/example-queries.ts that re-exports the original symbols and
reference it in "exports"), or alternatively document and perform this change
only behind a major-version bump and deprecation notice; update the "exports"
map to include "./omnigraph-api/example-queries": "<path-to-reexport>" so
imports targeting that subpath continue to resolve.
🪄 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: 4f5dabb3-4ce4-453c-9cab-654f3e7787bd

📥 Commits

Reviewing files that changed from the base of the PR and between b37d070 and aa9eadf.

📒 Files selected for processing (9)
  • docs/ensnode.io/src/components/molecules/OmnigraphAPIExamplePanels.astro
  • docs/ensnode.io/src/components/organisms/OmnigraphAPIExample.astro
  • docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/example.mdx
  • docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/example.mdx
  • docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/schema-reference.mdx
  • docs/ensnode.io/src/content/docs/docs/services/ensrainbow/concepts/creating-files.mdx
  • docs/ensnode.io/src/data/omnigraph-examples/responses.json
  • docs/ensnode.io/src/lib/playground/utils.ts
  • packages/ensnode-sdk/package.json

Comment thread packages/ensnode-sdk/package.json
Copy link
Copy Markdown
Member

@lightwalker-eth lightwalker-eth left a comment

Choose a reason for hiding this comment

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

@sevenzing Looks good, thanks for the updates 👍

@lightwalker-eth lightwalker-eth merged commit fc128f7 into main May 19, 2026
19 of 20 checks passed
@lightwalker-eth lightwalker-eth deleted the ll/docs-examples-improve-02 branch May 19, 2026 21:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants