Skip to content

docs: make resolve example to be actual guide#2262

Open
sevenzing wants to merge 6 commits into
mainfrom
ll/domain-profile-examples
Open

docs: make resolve example to be actual guide#2262
sevenzing wants to merge 6 commits into
mainfrom
ll/domain-profile-examples

Conversation

@sevenzing
Copy link
Copy Markdown
Member

@sevenzing sevenzing commented Jun 5, 2026

Lite PR

Tip: Review docs on the ENSNode PR process

Summary

  • What changed (1-3 bullets, no essays).

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 June 5, 2026 14:59
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jun 5, 2026

⚠️ No Changeset found

Latest commit: 5a6eab1

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 Jun 5, 2026

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

Project Deployment Actions Updated (UTC)
admin.ensnode.io Ready Ready Preview, Comment Jun 5, 2026 3:01pm
enskit-react-example.ensnode.io Ready Ready Preview, Comment Jun 5, 2026 3:01pm
ensnode.io Ready Ready Preview, Comment Jun 5, 2026 3:01pm
ensrainbow.io Ready Ready Preview, Comment Jun 5, 2026 3:01pm

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 5, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: f8643cf1-87f3-4efa-b441-29822707e3f6

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch ll/domain-profile-examples

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 Jun 5, 2026

Greptile Summary

This PR converts the two standalone domain-profile and domain-records example pages into a single narrative guide page (resolver-records.mdx) that explains the two resolution layers with prose context, embeds all three examples inline (including a new domain-profile-compare combined query), and introduces a catalog abstraction (OMNIGRAPH_EXAMPLES_CATALOG_ITEMS) that allows guide pages and hosted example pages to coexist in the sidebar.

  • Deletes domain-profile.mdx and domain-records.mdx; adds resolver-records.mdx with narrative prose and three embedded OmnigraphStaticExampleSet components.
  • Adds OMNIGRAPH_EXAMPLES_GUIDE_PAGES, getOmnigraphExamplesCatalogItems(), and OMNIGRAPH_EXAMPLES_CATALOG_ITEMS in config.ts to unify guide pages and hosted example pages into a single ordered list used by the index page and sidebar.
  • Adds a new domain-profile-compare example query across examples.json, responses.json, example-queries.ts, and SKILL.md.

Confidence Score: 4/5

Documentation and data-file change — no runtime logic or API surface is modified; safe to merge after the minor cleanup notes are addressed or acknowledged.

The catalog abstraction is clean and well-tested. The only items worth noting are that visibleOmnigraphExamples in examples.ts is now an unused export (its sole consumer was updated to use the new catalog), and the JSDoc on getOmnigraphExamplesCatalogItems describes 'interleaved' ordering when the implementation actually concatenates all guide pages before all hosted pages.

docs/ensnode.io/src/data/omnigraph-examples/examples.ts (unused export) and docs/ensnode.io/src/data/omnigraph-examples/config.ts (misleading JSDoc comment)

Important Files Changed

Filename Overview
docs/ensnode.io/src/data/omnigraph-examples/config.ts Adds guide-page types, OMNIGRAPH_EXAMPLES_GUIDE_PAGES, getOmnigraphExamplesCatalogItems, and OMNIGRAPH_EXAMPLES_CATALOG_ITEMS; changes domain-profile and domain-records to hostSeparatePage: false; adds domain-profile-compare example. Minor: the JSDoc on getOmnigraphExamplesCatalogItems says 'interleaved' but the implementation concatenates guide pages then hosted pages.
docs/ensnode.io/src/data/omnigraph-examples/config.test.ts Updates test to use getOmnigraphExamplesCatalogItems; adds new test that verifies guide pages appear before hosted example pages in the catalog.
docs/ensnode.io/src/content/docs/docs/integrate/omnigraph/examples/resolver-records.mdx New narrative guide page that replaces the two deleted standalone pages, embedding domain-profile, domain-records, and domain-profile-compare examples with prose context explaining the two resolution layers.
docs/ensnode.io/src/data/omnigraph-examples/examples.json Adds the domain-profile-compare query entry with correct variables.
docs/ensnode.io/src/data/omnigraph-examples/responses.json Adds domain-profile-compare mock response; refreshes trace IDs and timestamps for domain-profile; reorders fields in account-migrated-names and hello-world responses (cosmetic only).
packages/ensnode-sdk/src/omnigraph-api/example-queries.ts Adds domain-profile-compare query to the SDK example queries list, consistent with the docs addition.
packages/ensskills/skills/omnigraph/SKILL.md Documents the new domain-profile-compare example in the skill markdown.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[OMNIGRAPH_EXAMPLES_GUIDE_PAGES] -->|guide slugs| B[getOmnigraphExamplesCatalogItems]
    C[OMNIGRAPH_EXAMPLES_CONFIG\nhostSeparatePage: true] -->|hosted pages| B
    B --> D[OMNIGRAPH_EXAMPLES_CATALOG_ITEMS]
    D --> E[index.mdx\nLinkCard grid]
    D --> F[OMNIGRAPH_EXAMPLES_SIDEBAR_ITEMS\nStarlight sidebar]
    G[resolver-records.mdx\nnew guide page] -->|embeds| H[OmnigraphStaticExampleSet\ndomain-profile]
    G -->|embeds| I[OmnigraphStaticExampleSet\ndomain-records]
    G -->|embeds| J[OmnigraphStaticExampleSet\ndomain-profile-compare NEW]
    K[domain-profile.mdx\nDELETED] -. replaced by .-> G
    L[domain-records.mdx\nDELETED] -. replaced by .-> G
Loading

Reviews (1): Last reviewed commit: "make resolve example to be actual guide" | Re-trigger Greptile

href: string;
};

/** Examples index and sidebar order: hosted example pages interleaved with guide pages. */
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 Misleading "interleaved" comment

The JSDoc says "guide pages interleaved with guide pages" but the implementation unconditionally appends all guide pages first and all hosted example pages second — they are concatenated, not interleaved. If a future developer adds a second guide page and expects it to appear between two hosted pages, they will be surprised by the behavior.

Base automatically changed from ll/docs-examples-improve-04 to main June 6, 2026 11:44
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.

1 participant