Skip to content

Remove outdated and unused documentation files#903

Merged
DZakh merged 3 commits into
mainfrom
claude/find-dead-pages-bDLVv
May 5, 2026
Merged

Remove outdated and unused documentation files#903
DZakh merged 3 commits into
mainfrom
claude/find-dead-pages-bDLVv

Conversation

@DZakh
Copy link
Copy Markdown
Member

@DZakh DZakh commented May 5, 2026

Summary

This PR removes a collection of outdated and unused documentation files that are no longer maintained or relevant to the current codebase.

Changes Made

  • Removed todo/simple-bank.md - Outdated SimpleBank contract documentation with syntax marked as no longer in use
  • Removed docs/unused/array-label.mdx - Documentation for loading entity arrays feature
  • Removed docs/unused/subgraph-migration.md - Experimental subgraph migration documentation
  • Removed docs/unused/example-erc4626-token-vault.md - Example indexer documentation for ERC4626 token vaults
  • Removed docs/unused/example-on-chain-governance.md - Example indexer documentation for on-chain governance
  • Removed docs/unused/example-aave-token.md - Example indexer documentation for AAVE token
  • Removed docs/unused/example-reNFT.md - Example indexer documentation for reNFT contract
  • Removed docs/unused/overview-everything.md - Outdated overview documentation

Notes

All removed files were either explicitly marked as outdated/unused or located in the docs/unused/ directory, indicating they are no longer part of the active documentation set. This cleanup improves repository maintainability by removing stale documentation that could cause confusion.

https://claude.ai/code/session_015vNRDvd8HngiAqboJBmoHN

Summary by CodeRabbit

  • Documentation
    • Removed numerous deprecated/unused documentation pages and example walkthroughs to streamline content and reduce maintenance.
    • Consolidated navigation and redirects to point example links to the HyperIndex overview and removed now-obsolete sidebar entries.
    • Updated guides to simplify prerequisites (removed a specific CLI version check) and adjusted a blog post's example links.

These pages were not served by any Docusaurus plugin, not present in
any sidebar, not redirect targets, and not linked from any other page
or blog post.
@vercel
Copy link
Copy Markdown

vercel Bot commented May 5, 2026

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

Project Deployment Actions Updated (UTC)
envio-docs Ready Ready Preview, Comment May 5, 2026 0:36am

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 5, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 69c8d7bb-4ea8-43b5-b123-fd22f7f511df

📥 Commits

Reviewing files that changed from the base of the PR and between 657b3a4 and 75b5bf0.

📒 Files selected for processing (1)
  • docs/HyperIndex/Guides/testing.mdx

📝 Walkthrough

Walkthrough

This PR removes multiple obsolete documentation pages, updates docusaurus redirects and generated LLM content, deletes two commented sidebar entries, and updates a blog post's example links. No runtime source code changes.

Changes

Documentation removal + site wiring updates

Layer / File(s) Summary
Removed documentation pages
docs/unused/array-label.mdx, docs/unused/example-aave-token.md, docs/unused/example-erc4626-token-vault.md, docs/unused/example-on-chain-governance.md, docs/unused/example-reNFT.md, docs/unused/overview-everything.md, docs/unused/subgraph-migration.md, docs/HyperIndex/Examples/example-ens.md, docs/HyperIndex/Examples/example-liquidation-metrics.md, todo/simple-bank.md
Deleted full frontmatter and body content for these example/guide pages; files no longer contain the prior documentation.
Site config — redirects & LLM root
docusaurus.config.js
Redirect targets for /docs/example-liquidation-metrics and /docs/example-ens changed to /docs/HyperIndex/overview; removed two example links from the generated LLM root/llms.txt content.
Sidebar tidy
sidebarsHyperIndex.js
Removed two commented-out example entries from the “Examples” category items array.
Docs content update
docs/HyperIndex/Guides/testing.mdx
Removed the Envio CLI version verification step from Getting Started and Troubleshooting sections.
Blog update
blog/2023-11-15-simplify-data-retrieval-multi-chain-dapps.md
Replaced references to the Compound V2 Liquidation Metrics example with the Uniswap V4 multichain indexer in two locations.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • enviodev/docs#833: Also removes legacy documentation pages and updates config/sidebar entries.
  • enviodev/docs#748: Edits the same example-liquidation-metrics documentation (related content overlap).
  • enviodev/docs#706: Modifies docusaurus LLM generation and related config (LLM/llms.txt overlap).

Suggested reviewers

  • keenbeen32
  • DenhamPreen

Poem

I’m a rabbit with scissors, hopping through prose,
I prune stale pages where old knowledge froze.
Links get rerouted, comments tuck in tight,
The docs sleep lighter under moonlight. 🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title accurately reflects the main objective: removing outdated and unused documentation files. It is concise, specific, and directly summarizes the primary change.
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 claude/find-dead-pages-bDLVv

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

Both pages were excluded from the sidebar but still served via direct
URL. Removing the files, llms.txt entries, and commented sidebar lines.
The /docs/example-ens and /docs/example-liquidation-metrics redirects
now point to the HyperIndex overview. Updated the one blog link that
referenced example-liquidation-metrics to point to the Uniswap V4
multichain example instead.
The testing library has been bundled with HyperIndex for many releases;
the v0.0.26 prerequisite line predates V3 and is no longer meaningful.
Drops the prerequisite bullet and the corresponding troubleshooting
step, renumbering the remaining items.
@DZakh DZakh enabled auto-merge (squash) May 5, 2026 12:27
@DZakh DZakh merged commit 5f58115 into main May 5, 2026
2 of 3 checks passed
@DZakh DZakh deleted the claude/find-dead-pages-bDLVv branch May 5, 2026 12:30
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.

3 participants