Update CLI commands to use pnpx envio@2 instead of pnpx envio#905
Open
DZakh wants to merge 16 commits intoclaude/investigate-doc-versioning-66hsGfrom
Open
Update CLI commands to use pnpx envio@2 instead of pnpx envio#905DZakh wants to merge 16 commits intoclaude/investigate-doc-versioning-66hsGfrom
DZakh wants to merge 16 commits intoclaude/investigate-doc-versioning-66hsGfrom
Conversation
Update all envio init command invocations across the HyperIndex V2 docs to use pnpx envio@2 init so users on the v2 docs install the v2 CLI explicitly instead of picking up newer majors by default.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
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: defaults Review profile: CHILL 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)
Comment |
The header dropdown label was hardcoded to 'v3', so visiting v2 docs still showed 'v3' in the navbar. Swizzle NavbarItem/ComponentTypes to register a custom-versionDropdown that reads the current pathname and renders the underlying DropdownNavbarItem with 'v2' or 'v3' accordingly.
…g-66hsG' into claude/update-hyperindex-docs-CoJrb # Conflicts: # docusaurus.config.js # src/theme/NavbarItem/ComponentTypes.js
Update all envio init command invocations across the HyperIndex V3 docs to use pnpx envio@3.0.0-rc.0 init so users on the v3 docs install the v3 release candidate explicitly instead of picking up whatever's published as latest.
Place it after the Feature Roadmap section in the V3 overview and reword to reflect that an API token is now required (no longer 'soon'). Point users at the Envio Cloud portal to generate a token.
Replace the previous roadmap items with isolated multichain mode, polished Solana support, and indexing 1,000,000+ events per second.
Drop the 'rate limits for requests without API tokens' phrasing since unauthenticated requests aren't possible. State that an API token is required for all requests.
Update prerequisite lists across the V3 quickstart, getting-started, and tutorials so they no longer require pnpm v8+. pnpm is now recommended but other package managers are supported.
pnpm is no longer a hard requirement, so the 'requires pnpm v8 or newer' troubleshooting entry is obsolete.
- Move Prerequisites and the third 'Getting Started Guide' video into the Quickstart page (docs/HyperIndex/contract-import.md), and add a small 'Other ways to start' callout pointing at templates and examples. - Rename the page slug from /contract-import to /quickstart so the URL matches its sidebar label (the file id is unchanged so all relative ./contract-import links still resolve). - Delete docs/HyperIndex/getting-started.md and drop it from the HyperIndex sidebar. - Repoint inbound prose links (quickstart-with-ai, migrate-from-alchemy, migrate-from-ponder, migration-guide, two Examples) at the Quickstart. - Rewrite every absolute /docs/HyperIndex/contract-import URL across V3 docs (overview + supported-networks + tutorials) to /docs/HyperIndex/ quickstart. - Add client redirects from /docs/HyperIndex/getting-started and /docs/HyperIndex/contract-import to the new Quickstart slug, and repoint the existing /docs/getting-started and /docs/hyperindex-basics redirects. - Drop the stale Getting Started entry from the LLM context block.
The slug rename to /quickstart left a few stragglers that broke the docusaurus build: - docusaurus.config.js redirect /docs/contract-import still pointed at the now-removed /docs/HyperIndex/contract-import target. - scripts/update-endpoints.js auto-generates supported-networks pages from a template that hardcoded /docs/HyperIndex/contract-import. - quickstart-with-ai.md still relatively linked ./contract-import. - common-issues.md TOC referenced #using-the-correct-version-of-pnpm, whose section was removed earlier. Verified locally with yarn build (exit 0).
V3 introduced an auto-discovered src/handlers directory (see migrate-to-v3.md) that replaces the explicit src/EventHandlers.<ext> file path. This commit reflects that rename across: - All HyperIndex V3 prose, code blocks, and config snippets. - The supported-networks template in scripts/update-endpoints.js, so newly generated network pages use src/handlers.
V3 auto-discovers handler files under src/handlers, so the explicit handler: src/handlers field in config.yaml examples is no longer needed. Stripped from all V3 config snippets across docs/HyperIndex/ and from the supported-networks template in update-endpoints.js. Also tightened the dynamic-contracts.md prose to point at src/handlers/<ContractName>.ts (the per-contract file) instead of the ambiguous bare directory.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated all documentation references to use the versioned CLI command
pnpx envio@2instead of the unversionedpnpx enviocommand across multiple guide and tutorial files.Key Changes
pnpx envio inittopnpx envio@2 initacross 14 documentation filesImplementation Details
This is a documentation-only change that ensures users follow the correct versioned CLI command. The
@2version specifier ensures users get the intended major version of the Envio CLI tool when running initialization commands.https://claude.ai/code/session_012Ne15Kf1TbyFLQfUhhmmDD