docs: make resolve example to be actual guide#2262
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
Greptile SummaryThis PR converts the two standalone
Confidence Score: 4/5Documentation 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 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
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
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. */ |
There was a problem hiding this comment.
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.
|
will be implemented in #2273 |
Lite PR
Tip: Review docs on the ENSNode PR process
Summary
Why
Testing
Notes for Reviewer (Optional)
Pre-Review Checklist (Blocking)