Kv/improve upgrade envio docs

[keenbeen32]

Added upgrade envio version section and reccomended file structure for block handlers.

Summary by CodeRabbit

• Documentation

  • Enhanced guidance on declaring and importing block handlers through handler files referenced in config.yaml. Includes recommended approach using index handler files with configuration examples and implementation patterns for proper handler registration and execution.

• Chores

  • Reformatted supported networks configuration.

[vercel]

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

Project	Deployment	Preview	Comments	Updated (UTC)
envio-docs	Ready	Preview	Comment	Nov 6, 2025 0:30am

[coderabbitai]

Walkthrough

Adds documentation clarifying that block handlers must be declared in or imported by a handler file referenced in config.yaml, along with a recommended pattern using an index handler file. Additionally, reformats the supported-networks.json array for readability without functional changes.

Changes

Cohort / File(s)	Summary
Documentation Updates docs/HyperIndex/Guides/block-handlers.md	Adds guidance on block handler registration requirements, showing that standalone block handler files will not run. Documents best practice of creating an index handler file (EventHandlers.ts) imported in config.yaml to ensure proper handler registration and execution. Includes Before/After config examples.
JSON Reformatting supported-networks.json	Reflowed JSON array across multiple lines with adjusted comma placement. Functionally equivalent; formatting change only.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation additions are informational; verify accuracy of guidance about handler registration patterns.
• JSON change is purely cosmetic; no logic review required.

Possibly related issues

• #765: Addresses the same block handler registration behavior and clarifies requirement for handlers to be in/imported by a referenced config file.

Possibly related PRs

• v2.29 #703: Modifies the same docs/HyperIndex/Guides/block-handlers.md file with related documentation changes.

Suggested reviewers

• DenhamPreen

Poem

🐰 Hop along, dear handlers true,
In EventHandlers.ts, we'll index you,
Imported and declared with care,
Config knows your handlers are there!
No strays allowed in this warren fair, ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Kv/improve upgrade envio docs' is vague and uses non-descriptive formatting with a branch prefix, making it unclear what specific documentation improvements were made.	Revise the title to be more specific and descriptive, such as 'Document block handler declaration requirements and recommended file structure' or 'Add block handler setup guide to upgrade documentation'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch kv/improve-upgrade-envio-docs

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5b90408 and f7ebef8.

📒 Files selected for processing (1)

• docs/HyperIndex/Guides/block-handlers.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/HyperIndex/Guides/block-handlers.md

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dafce63 and ab7f2a9.

📒 Files selected for processing (3)

• docs/HyperIndex/Guides/block-handlers.md (1 hunks)
• docs/HyperIndex/Guides/upgrading-envio.md (1 hunks)
• sidebarsHyperIndex.js (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/HyperIndex/Guides/block-handlers.md

198-198: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

210-210: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (8)

docs/HyperIndex/Guides/block-handlers.md (2)

192-193: LGTM! Clear documentation of the handler registration requirement.

The limitation is well-stated and will help users understand the registration behavior.

---

222-227: LGTM! Clear example of the recommended centralized handler approach.

The EventHandlers.ts example clearly demonstrates how to import and centralize all handlers in one place.

sidebarsHyperIndex.js (1)

60-60: LGTM! Sidebar navigation updated correctly.

The new upgrading guide is appropriately placed in the Guides section.

docs/HyperIndex/Guides/upgrading-envio.md (5)

1-11: LGTM! Clear introduction and frontmatter.

The document metadata and introduction are well-structured and set clear expectations.

---

12-18: LGTM! Method 1 is clear and concise.

The recommended upgrade method using pnpm install envio@latest is straightforward and well-documented.

---

20-36: LGTM! Method 2 provides excellent guidance for version-specific installations.

The explanation of viewing available versions and identifying stable releases is particularly helpful for users who need more control over their upgrade process.

---

38-55: LGTM! Method 3 offers a valid alternative approach.

The manual package.json update method is clearly documented with step-by-step instructions.

---

57-71: LGTM! Verification and troubleshooting steps are helpful.

Including the version verification command and fallback uninstall/reinstall steps enhances the user experience when encountering upgrade issues.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

sidebarsHyperIndex.js (1)

59-59: LGTM - Minor formatting change.

The trailing comma removal is harmless. Note that line 86 still has a trailing comma after the last item in the Hosting items array, creating a minor inconsistency in comma usage across the file.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ab7f2a9 and 5b90408.

📒 Files selected for processing (2)

• sidebarsHyperIndex.js (1 hunks)
• supported-networks.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• supported-networks.json