Skip to content

docs: small doc improvements #2168

Open
sevenzing wants to merge 1 commit into
mainfrom
ll/docs-examples-improve-03
Open

docs: small doc improvements #2168
sevenzing wants to merge 1 commit into
mainfrom
ll/docs-examples-improve-03

Conversation

@sevenzing
Copy link
Copy Markdown
Member

Summary

  • Pin version in examples to enssdk@1.13.1
  • Fix some unclear wording

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 21, 2026 12:36
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented May 21, 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 21, 2026 12:52pm
ensnode.io Ready Ready Preview, Comment May 21, 2026 12:52pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
admin.ensnode.io Skipped Skipped May 21, 2026 12:52pm
ensrainbow.io Skipped Skipped May 21, 2026 12:52pm

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 21, 2026

⚠️ No Changeset found

Latest commit: 2f06166

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

@sevenzing
Copy link
Copy Markdown
Member Author

@greptile review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

Review Change Stack

Warning

Rate limit exceeded

@sevenzing has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 45 minutes and 54 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: b281e18b-e086-450f-a27b-481e8394fb13

📥 Commits

Reviewing files that changed from the base of the PR and between 590c479 and 2f06166.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • 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
  • examples/enskit-react-example/package.json
  • examples/enssdk-example/package.json
📝 Walkthrough

Walkthrough

Documentation and example dependencies are updated across the repository. Interactive StackBlitz example pages clarify in-browser execution behavior and user re-run steps, while example project dependencies stabilize from preview builds to the 1.13.1 release.

Changes

Example Documentation and Dependencies Update to 1.13.1

Layer / File(s) Summary
Interactive example documentation clarity
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
Documentation notes in enskit and enssdk interactive examples are updated to clarify StackBlitz runs in-browser, npm package install timing is general (not package-specific), and explicit re-run steps are documented.
Example dependency stabilization to 1.13.1
examples/enskit-react-example/package.json, examples/enssdk-example/package.json
Example project dependencies for enskit and enssdk are updated from preview builds to the stable 1.13.1 release.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

  • namehash/ensnode#2148: Both PRs update the interactive StackBlitz documentation for the enskit/enssdk examples, including adjustments to the "first load" note text.
  • namehash/ensnode#2146: Related to updates of the interactive enskit StackBlitz "First load" note text in the same example documentation file.

Suggested labels

docs

Poem

🐰 From preview builds to stable ground,
Our examples dance without a bound,
StackBlitz whispers secrets clear,
"Take a moment, have no fear!"
Version 1.13.1 shines so bright! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'docs: small doc improvements' is vague and generic, using non-descriptive terms that don't clearly convey the specific changes (version pinning and wording fixes). Consider a more specific title like 'docs: pin example versions to 1.13.1 and fix wording' to better describe the main changes.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description covers the main changes (version pinning and wording fixes) but omits the 'Why', 'Testing', and detailed 'Summary' sections required by the template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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-03

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 21, 2026

Greptile Summary

This PR pins enskit and enssdk from a preview SHA build to the stable 1.13.1 release in both example packages, and updates the interactive example docs with improved wording and a corrected load-time estimate.

  • Version pinning: enskit and enssdk move from 0.0.0-preview-fix-sha-89c022b-20260519094840 to 1.13.1 in examples/enskit-react-example/package.json, examples/enssdk-example/package.json, and pnpm-lock.yaml.
  • Docs rewording: The "First load" note now says "a few minutes" with clearer guidance about watching terminal output; the enssdk example moves the npm start instruction to after the outage caution.

Confidence Score: 5/5

Safe to merge — changes are limited to documentation wording and pinning two packages to their stable 1.13.1 release.

The package bumps replace a preview SHA build with the matching stable release and the lockfile is consistent. The doc edits only reorder admonitions and improve wording; no logic or API surface is affected.

No files require special attention.

Important Files Changed

Filename Overview
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/example.mdx Reworded "First load" note for clarity; removed vague "take a moment" phrasing; minor ordering difference vs. sibling enssdk page.
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/example.mdx Moved npm start instruction to after the outage caution; text now says "re-execute" instead of "run".
examples/enskit-react-example/package.json Bumped enskit and enssdk from preview SHA version to stable 1.13.1.
examples/enssdk-example/package.json Bumped enssdk from preview SHA version to stable 1.13.1.
pnpm-lock.yaml Lockfile updated to reflect version bumps; new enssdk@1.13.1 snapshot added with correct peer dependencies.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User visits example page] --> B{StackBlitz outage?}
    B -- Yes --> C[Click Fork on StackBlitz button]
    B -- No --> D[Wait for embedded editor to load\na few minutes]
    D --> E{enskit or enssdk example?}
    C --> E
    E -- enskit --> F[Vite + React app loads\nenskit@1.13.1 + enssdk@1.13.1]
    E -- enssdk --> G[TypeScript script loads\nenssdk@1.13.1]
    F --> H[Interact with preview pane]
    G --> I[Edit script, run npm start\nto re-execute]
Loading

Reviews (3): Last reviewed commit: "apply small doc imporvements" | Re-trigger Greptile

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 21, 2026

Greptile Summary

This PR promotes both enskit and enssdk example projects from a preview build (0.0.0-preview-fix-sha-89c022b-20260519094840) to the stable 1.13.1 release, and updates the pnpm lockfile accordingly. It also tightens the wording in both interactive-playground documentation pages.

  • Version pinning: examples/enskit-react-example and examples/enssdk-example now depend on enskit@1.13.1 / enssdk@1.13.1; the lockfile is consistent with these specifiers.
  • enskit doc: Rewrites the first-load note to name StackBlitz explicitly and extends the time estimate to "a few minutes"; removes the paragraph that told users to run npm start to restart the Vite dev server.
  • enssdk doc: Minor wording improvement — "run" → "re-execute" for clarity.

Confidence Score: 4/5

Safe to merge — changes are scoped to documentation wording and pinning stable package versions in example projects.

The dependency bumps from preview builds to 1.13.1 are straightforward and the lockfile is consistent. The one thing worth a second look is that the enskit example page no longer tells users how to restart the Vite dev server after editing, while the parallel enssdk page still has that instruction — this asymmetry could leave enskit example users without guidance in some scenarios.

docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/example.mdx — removed the npm start restart instruction without an equivalent replacement.

Important Files Changed

Filename Overview
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enskit/example.mdx Improved the first-load note to reference StackBlitz explicitly and extended time estimate; removed the paragraph instructing users to run npm start after the project loads.
docs/ensnode.io/src/content/docs/docs/integrate/integration-options/enssdk/example.mdx Minor wording improvement: "run" changed to "re-execute" for clarity. No structural changes.
examples/enskit-react-example/package.json Bumped enskit and enssdk from a preview build to the stable 1.13.1 release.
examples/enssdk-example/package.json Bumped enssdk from a preview build to the stable 1.13.1 release.
pnpm-lock.yaml Lock file regenerated to reflect stable 1.13.1 resolutions for enskit and enssdk, replacing the preview build entries.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User opens enskit or enssdk\ndoc page] --> B[Sees StackBlitz embed]
    B --> C{Editor loads?}
    C -- Yes --> D[Install npm packages\n~a few minutes]
    C -- No --> E[Click 'Fork on StackBlitz'\nto open on stackblitz.com]
    D --> F{Which example?}
    F -- enskit react app --> G[Vite dev server\nauto-starts]
    F -- enssdk script --> H[Run npm start\nin terminal]
    G --> I[Interact via Preview pane]
    H --> J[View script output\nin terminal]
Loading

Reviews (2): Last reviewed commit: "apply small doc imporvements" | Re-trigger Greptile

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