docs: update docs#2005
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:
📝 WalkthroughWalkthroughThe PR refactors Docker infrastructure by renaming the Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~22 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 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 |
Greptile SummaryThis PR migrates Docker documentation to a docs-site-first strategy: Confidence Score: 5/5Safe to merge; all changes are documentation with no runtime impact No P0 or P1 issues. The only notable finding is a potential documentation inaccuracy around Docker Compose .env resolution path (P2), and the three TBD stub pages were already addressed in the prior review thread. No code logic or runtime behavior is affected by this PR. docs/ensnode.io/src/content/docs/docs/deploying/docker.mdx — the docker/.env auto-pickup claim on line 44 should be verified against actual Docker Compose V2 project-directory resolution behavior Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User lands on ENSNode Docs] --> B{Choose quickstart path}
B --> C[Quickly test ENSNode data]
B --> D[Integrate with Omnigraph API]
B --> E[Integrate with enssdk]
B --> F[Integrate with ensjs]
B --> G[Integrate with enskit]
B --> H[Integrate via viem/chain]
B --> I[Run your own ENSNode]
C --> C1[Hosted ENSNode Instances]
D --> D1[omnigraph-api.mdx TBD]
E --> E1[with-enssdk.mdx TBD]
F --> F1[with-ensjs.mdx]
G --> G1[with-enskit.mdx TBD]
H --> H1[with-viem.mdx]
I --> I1[deploying/docker.mdx]
Reviews (3): Last reviewed commit: "add ENSNODE_TAG to docs" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
|
|
||
| TBD |
There was a problem hiding this comment.
The index page now prominently routes users to omnigraph-api, with-enssdk, and with-enskit as primary quickstart paths, but all three pages contain only TBD. Consider adding an :::caution[Coming Soon] admonition or similar Starlight callout so users understand the content is in progress rather than encountering a blank page. The same applies to with-enssdk.mdx and with-enskit.mdx.
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
There was a problem hiding this comment.
should probably remove this page rather than leave stubbed, unless planning on fast-following with content
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
|
|
||
| TBD |
There was a problem hiding this comment.
should probably remove this page rather than leave stubbed, unless planning on fast-following with content
|
|
||
| TBD |
| "generate:openapi": "pnpm -r --if-present generate:openapi", | ||
| "generate:gqlschema": "pnpm -F ensapi generate:gqlschema && pnpm -F enssdk generate:gqlschema" | ||
| "generate:gqlschema": "pnpm -F ensapi generate:gqlschema && pnpm -F enssdk generate:gqlschema", | ||
| "docs:dev": "pnpm -F @docs/ensnode dev" |
There was a problem hiding this comment.
hmm, we don't have any other shorthands for subproject dev scripts in the monorepo root; i see that it's more convenient but then i'd prefer to have all or none, wdyt?
2 participants
Summary
docker/README.md, expandeddeploying/docker.mdx, and aligned contributor docs for detached compose usage.docs/index.mdxinto use-case paths, added placeholder pages forenssdk,enskit, and Omnigraph API, and reordered usage sidebar pages.Testing
pnpm docs:devand checked everything is correct.Pre-Review Checklist (Blocking)