Optimise docs for Unigraph examples#2202
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Caution Review failedPull request was closed or merged during review No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (7)
📝 WalkthroughWalkthroughAdds four Astro documentation molecule components (ENS reader/indexer/node intros and a collapsible JSON viewer) and composes them into multiple Unigraph example MDX pages, which now export fixture JSON and render the new components in tabbed examples. ChangesDocumentation Components and Examples
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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 polishes the Unigraph examples documentation by extracting repeated explanatory text into reusable Astro components (
Confidence Score: 4/5Safe to merge after fixing one rendering defect in EnsIndexerSchemaIntro.astro where a backtick-formatted identifier will display as literal backtick characters in the browser. The new EnsIndexerSchemaIntro component uses raw Markdown-style backticks inside an Astro HTML template, where they are not interpreted — users will see literal backtick characters around ENSINDEXER_SCHEMA_NAME instead of inline-code formatting. Every other identifier in the same component is correctly wrapped in code tags, making this a clear oversight. docs/ensnode.io/src/components/molecules/EnsIndexerSchemaIntro.astro — line 18 uses backtick notation inside an HTML template where it will not be converted to code formatting. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
subgraph New Molecule Components
A[EnsDbReaderIntro.astro]
B[EnsIndexerSchemaIntro.astro]
C[EnsNodeSchemaIntro.astro]
D[ResultDetails.astro]
end
subgraph Example Pages
F[domain-by-name.mdx]
G[account-domains.mdx]
H[indexing-status.mdx]
end
A -->|imported by| F
A -->|imported by| G
A -->|imported by| H
B -->|imported by| F
B -->|imported by| G
C -->|imported by| H
D -->|imported by| F
D -->|imported by| G
D -->|imported by| H
Reviews (8): Last reviewed commit: "Merge branch 'docs/improve-unigraph-exam..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull request overview
This PR refines the Unigraph SQL example docs by adding reusable “intro” asides and collapsible example result renderers, aiming to address follow-up feedback from #2199.
Changes:
- Adds reusable Starlight
<Aside>components to explain ENSNode Schema, ENSIndexer Schema, and ENSDb Reader usage in examples. - Adds a
ResultDetailscomponent and embeds example result JSON under SQL and ensdb-sdk tabs. - Updates the “Connect” overview page copy and relocates the “Canonical fields” note into a specific example page.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/indexing-status.mdx | Adds schema/reader intro asides, example result JSON, and result rendering for indexing status. |
| docs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/index.mdx | Expands EnsDbReader explanation and adjusts notes for the examples landing page. |
| docs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/domain-by-name.mdx | Adds schema/reader intro asides, example result JSON, and result rendering for domain lookup. |
| docs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/account-domains.mdx | Adds schema/reader intro asides, example result JSON, and result rendering for owner domain counts. |
| docs/ensnode.io/src/components/molecules/ResultDetails.astro | New reusable collapsible JSON result renderer for docs examples. |
| docs/ensnode.io/src/components/molecules/EnsNodeSchemaIntro.astro | New reusable aside explaining the ENSNode schema. |
| docs/ensnode.io/src/components/molecules/EnsIndexerSchemaIntro.astro | New reusable aside explaining the ENSIndexer schema name used in examples. |
| docs/ensnode.io/src/components/molecules/EnsDbReaderIntro.astro | New reusable aside pointing readers to the “Connect” section for SDK setup. |
Comments suppressed due to low confidence (3)
docs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/indexing-status.mdx:155
- There is an extra trailing triple-backtick fence after
</Tabs>. This will break MDX parsing / render the remainder of the page as a code block. Remove the stray ```.
</TabItem>
</Tabs>
**docs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/domain-by-name.mdx:107**
* There is an extra trailing triple-backtick fence at the end of the file. This will break MDX parsing / render unintended content as code. Remove the stray ```.
docs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/account-domains.mdx:53
- There is an extra trailing triple-backtick fence at the end of the file. This will break MDX parsing / render unintended content as code. Remove the stray ```.
</TabItem>
</Tabs>
</details>
---
💡 <a href="/namehash/ensnode/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.
![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/components/molecules/EnsNodeSchemaIntro.astro`:
- Line 12: In the EnsNodeSchemaIntro component text there is duplicated wording
"There can just be just one ENSNode Schema per ENSDb"; update the copy in
EnsNodeSchemaIntro.astro to remove the duplicate "just" (e.g., "There can just
be one ENSNode Schema per ENSDb" or "There can be just one ENSNode Schema per
ENSDb") so the sentence reads cleanly.
🪄 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: 4fb7441b-42d6-46e9-a533-a627f5700971
📒 Files selected for processing (8)
docs/ensnode.io/src/components/molecules/EnsDbReaderIntro.astrodocs/ensnode.io/src/components/molecules/EnsIndexerSchemaIntro.astrodocs/ensnode.io/src/components/molecules/EnsNodeSchemaIntro.astrodocs/ensnode.io/src/components/molecules/ResultDetails.astrodocs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/account-domains.mdxdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/domain-by-name.mdxdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/index.mdxdocs/ensnode.io/src/content/docs/docs/integrate/unigraph/examples/indexing-status.mdx
tk-o
force-pushed
the
docs/improve-unigraph-examples-content
branch
from
560a791 to
5ab3e68
Compare
tk-o
force-pushed
the
docs/improve-unigraph-examples-content
branch
from
382e551 to
7ec98c5
Compare
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
lightwalker-eth
left a comment
lightwalker-eth
left a comment
There was a problem hiding this comment.
@tk-o Thanks for these updates. Shared a few comments please take the lead to merge when ready 👍 Please continue to advance the priority docs updates in another separate PR.
| import EnsIndexerSchemaIntro from "@components/molecules/EnsIndexerSchemaIntro.astro"; | ||
| import EnsDbReaderIntro from "@components/molecules/EnsDbReaderIntro.astro"; | ||
|
|
||
| export const resultJson = [ |
There was a problem hiding this comment.
This example result is not interesting and doesn't communicate the big idea of the whole example. A proper example needs to include a count of ENSv2 domains too!
…-examples-content
…amehash/ensnode into docs/improve-unigraph-examples-content
This PR is a followup to PR #2199, and addresses the "Quick Feedback" (point 8., 9., and 10.) section the doc discussed in this thread.