From 97b9d569c71f83c70bb8961e8be940e1c09a1e09 Mon Sep 17 00:00:00 2001 From: Nikhil Bhintade <29760727+nikbhintade@users.noreply.github.com> Date: Thu, 25 Sep 2025 04:58:03 +0000 Subject: [PATCH 1/3] feat: llm.txt generation --- .../HyperRPC/hyperrpc-supported-networks.md | 2 - .../HyperSync/hypersync-supported-networks.md | 2 - docusaurus.config.js | 993 ++++++++++-------- package.json | 3 +- supported-networks.json | 2 +- yarn.lock | 28 + 6 files changed, 577 insertions(+), 453 deletions(-) diff --git a/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md b/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md index e8368c10..830ff19b 100644 --- a/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md +++ b/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md @@ -39,10 +39,8 @@ Here is a table of the currently supported networks on HyperRPC and their respec | Bsc | 56 | https://bsc.rpc.hypersync.xyz or https://56.rpc.hypersync.xyz | | | Bsc Testnet | 97 | https://bsc-testnet.rpc.hypersync.xyz or https://97.rpc.hypersync.xyz | | | Celo | 42220 | https://celo.rpc.hypersync.xyz or https://42220.rpc.hypersync.xyz | | -| Chainweb Testnet 20 | 5920 | https://chainweb-testnet-20.rpc.hypersync.xyz or https://5920.rpc.hypersync.xyz | | | Chainweb Testnet 21 | 5921 | https://chainweb-testnet-21.rpc.hypersync.xyz or https://5921.rpc.hypersync.xyz | | | Chainweb Testnet 22 | 5922 | https://chainweb-testnet-22.rpc.hypersync.xyz or https://5922.rpc.hypersync.xyz | | -| Chainweb Testnet 23 | 5923 | https://chainweb-testnet-23.rpc.hypersync.xyz or https://5923.rpc.hypersync.xyz | | | Chainweb Testnet 24 | 5924 | https://chainweb-testnet-24.rpc.hypersync.xyz or https://5924.rpc.hypersync.xyz | | | Chiliz | 88888 | https://chiliz.rpc.hypersync.xyz or https://88888.rpc.hypersync.xyz | | | Citrea Testnet | 5115 | https://citrea-testnet.rpc.hypersync.xyz or https://5115.rpc.hypersync.xyz | | diff --git a/docs/HyperSync/hypersync-supported-networks.md b/docs/HyperSync/hypersync-supported-networks.md index 3f18ab6a..54fefd2f 100644 --- a/docs/HyperSync/hypersync-supported-networks.md +++ b/docs/HyperSync/hypersync-supported-networks.md @@ -47,10 +47,8 @@ If you are a network operator or user and would like improved service support or | Bsc | 56 | https://bsc.hypersync.xyz or https://56.hypersync.xyz | 🥉 | | | Bsc Testnet | 97 | https://bsc-testnet.hypersync.xyz or https://97.hypersync.xyz | 🎒 | | | Celo | 42220 | https://celo.hypersync.xyz or https://42220.hypersync.xyz | 🪨 | | -| Chainweb Testnet 20 | 5920 | https://chainweb-testnet-20.hypersync.xyz or https://5920.hypersync.xyz | 🪨 | | | Chainweb Testnet 21 | 5921 | https://chainweb-testnet-21.hypersync.xyz or https://5921.hypersync.xyz | 🪨 | | | Chainweb Testnet 22 | 5922 | https://chainweb-testnet-22.hypersync.xyz or https://5922.hypersync.xyz | 🪨 | | -| Chainweb Testnet 23 | 5923 | https://chainweb-testnet-23.hypersync.xyz or https://5923.hypersync.xyz | 🪨 | | | Chainweb Testnet 24 | 5924 | https://chainweb-testnet-24.hypersync.xyz or https://5924.hypersync.xyz | 🪨 | | | Chiliz | 88888 | https://chiliz.hypersync.xyz or https://88888.hypersync.xyz | 🪨 | | | Citrea Testnet | 5115 | https://citrea-testnet.hypersync.xyz or https://5115.hypersync.xyz | 🪨 | | diff --git a/docusaurus.config.js b/docusaurus.config.js index b0bd49fc..efb3d8dd 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -3,465 +3,564 @@ const lightCodeTheme = themes.github; const darkCodeTheme = themes.dracula; const redirectsList = [ - { - from: "/docs", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/quickstart", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/overview", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/getting-started", - to: "/docs/HyperIndex/getting-started", - }, - { - from: "/docs/contract-import", - to: "/docs/HyperIndex/contract-import", - }, - { - from: "/docs/configuration-file", - to: "/docs/HyperIndex/configuration-file", - }, - { - from: "/docs/schema", - to: "/docs/HyperIndex/schema", - }, - { - from: "/docs/event-handlers", - to: "/docs/HyperIndex/event-handlers", - }, - { - from: "/docs/testing", - to: "/docs/HyperIndex/testing", - }, - { - from: "/docs/running-locally", - to: "/docs/HyperIndex/running-locally", - }, - { - from: "/docs/navigating-hasura", - to: "/docs/HyperIndex/navigating-hasura", - }, - { - from: "/docs/cli-commands", - to: "/docs/HyperIndex/cli-commands", - }, - { - from: "/docs/hosted-service", - to: "/docs/HyperIndex/hosted-service", - }, - { - from: "/docs/hosted-service-deployment", - to: "/docs/HyperIndex/hosted-service-deployment", - }, - { - from: "/docs/hosted-service-billing", - to: "/docs/HyperIndex/hosted-service-billing", - }, - { - from: "/docs/licensing", - to: "/docs/HyperIndex/licensing", - }, - { - from: "/docs/fuel", - to: "/docs/HyperIndex/fuel", - }, - { - from: "/docs/tutorial-op-bridge-deposits", - to: "/docs/HyperIndex/tutorial-op-bridge-deposits", - }, - { - from: "/docs/tutorial-erc20-token-transfers", - to: "/docs/HyperIndex/tutorial-erc20-token-transfers", - }, - { - from: "/docs/tutorial-indexing-fuel", - to: "/docs/HyperIndex/tutorial-indexing-fuel", - }, - { - from: "/docs/greeter-tutorial", - to: "/docs/HyperIndex/greeter-tutorial", - }, - { - from: "/docs/linked-entity-loaders", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/HyperIndex/v2/migration-guide-v1-v2", - to: "/docs/HyperIndex/migration-guide-v1-v2", - }, - { - from: "/docs/HyperIndex/linked-entity-loaders", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/dynamic-contracts", - to: "/docs/HyperIndex/dynamic-contracts", - }, - { - from: "/docs/multichain-indexing", - to: "/docs/HyperIndex/multichain-indexing", - }, - { - from: "/docs/hypersync/", - to: "/docs/HyperIndex/hypersync", - }, - { - from: "/docs/rpc-sync", - to: "/docs/HyperIndex/rpc-sync", - }, - { - from: "/docs/persisted_files", - to: "/docs/HyperIndex/persisted_files", - }, - { - from: "/docs/generated-files", - to: "/docs/HyperIndex/generated-files", - }, - { - from: "/docs/terminology", - to: "/docs/HyperIndex/terminology", - }, - { - from: "/docs/async-mode", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/HyperIndex/async-mode", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/labels", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/HyperIndex/labels", - to: "/docs/HyperIndex/overview", - }, - { - from: "/docs/performance", - to: "/docs/HyperIndex/performance", - }, - { - from: "/docs/example-sablier-v2", - to: "/docs/HyperIndex/example-sablier", - }, - { - from: "/docs/example-liquidation-metrics", - to: "/docs/HyperIndex/example-liquidation-metrics", - }, - { - from: "/docs/example-uniswap-v3", - to: "/docs/HyperIndex/example-uniswap-v4-multi-chain-indexer", - }, - { - from: "/docs/example-uniswap-v4", - to: "/docs/HyperIndex/example-uniswap-v4-multi-chain-indexer", - }, - { - from: "/docs/example-ens", - to: "/docs/HyperIndex/example-ens", - }, - { - from: "/docs/logging", - to: "/docs/HyperIndex/logging", - }, - { - from: "/docs/common-issues", - to: "/docs/HyperIndex/common-issues", - }, - { - from: "/docs/error-codes", - to: "/docs/HyperIndex/error-codes", - }, - { - from: "/docs/reserved-words", - to: "/docs/HyperIndex/reserved-words", - }, - { - from: "/docs/hyperfuel", - to: "/docs/HyperIndex/fuel", - }, - //// HyperSync - { - from: "/docs/overview-hypersync", - to: "/docs/HyperSync/overview", - }, - { - from: "/docs/hypersync-usage", - to: "/docs/HyperSync/hypersync-usage", - }, - { - from: "/docs/hypersync-query", - to: "/docs/HyperSync/hypersync-query", - }, - { - from: "/docs/hypersync-clients", - to: "/docs/HyperSync/hypersync-clients", - }, - { - from: "/docs/hypersync-curl-example", - to: "/docs/HyperSync/hypersync-curl-examples", - }, - { - from: "/docs/hypersync-url-endpoints", - to: "/docs/HyperSync/hypersync-supported-networks", - }, - { - from: "/docs/HyperSync/hypersync-url-endpoints", - to: "/docs/HyperSync/hypersync-supported-networks", - }, - { - from: "/docs/HyperSync/hyperrpc-url-endpoints", - to: "/docs/HyperSync/hyperrpc-supported-networks", - }, - { - from: "/docs/hyperfuel-query", - to: "/docs/HyperSync/hyperfuel-query", - }, - { - from: "/docs/overview-hyperrpc", - to: "/docs/HyperSync/overview-hyperrpc", - }, + { + from: "/docs", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/quickstart", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/overview", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/getting-started", + to: "/docs/HyperIndex/getting-started", + }, + { + from: "/docs/contract-import", + to: "/docs/HyperIndex/contract-import", + }, + { + from: "/docs/configuration-file", + to: "/docs/HyperIndex/configuration-file", + }, + { + from: "/docs/schema", + to: "/docs/HyperIndex/schema", + }, + { + from: "/docs/event-handlers", + to: "/docs/HyperIndex/event-handlers", + }, + { + from: "/docs/testing", + to: "/docs/HyperIndex/testing", + }, + { + from: "/docs/running-locally", + to: "/docs/HyperIndex/running-locally", + }, + { + from: "/docs/navigating-hasura", + to: "/docs/HyperIndex/navigating-hasura", + }, + { + from: "/docs/cli-commands", + to: "/docs/HyperIndex/cli-commands", + }, + { + from: "/docs/hosted-service", + to: "/docs/HyperIndex/hosted-service", + }, + { + from: "/docs/hosted-service-deployment", + to: "/docs/HyperIndex/hosted-service-deployment", + }, + { + from: "/docs/hosted-service-billing", + to: "/docs/HyperIndex/hosted-service-billing", + }, + { + from: "/docs/licensing", + to: "/docs/HyperIndex/licensing", + }, + { + from: "/docs/fuel", + to: "/docs/HyperIndex/fuel", + }, + { + from: "/docs/tutorial-op-bridge-deposits", + to: "/docs/HyperIndex/tutorial-op-bridge-deposits", + }, + { + from: "/docs/tutorial-erc20-token-transfers", + to: "/docs/HyperIndex/tutorial-erc20-token-transfers", + }, + { + from: "/docs/tutorial-indexing-fuel", + to: "/docs/HyperIndex/tutorial-indexing-fuel", + }, + { + from: "/docs/greeter-tutorial", + to: "/docs/HyperIndex/greeter-tutorial", + }, + { + from: "/docs/linked-entity-loaders", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/HyperIndex/v2/migration-guide-v1-v2", + to: "/docs/HyperIndex/migration-guide-v1-v2", + }, + { + from: "/docs/HyperIndex/linked-entity-loaders", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/dynamic-contracts", + to: "/docs/HyperIndex/dynamic-contracts", + }, + { + from: "/docs/multichain-indexing", + to: "/docs/HyperIndex/multichain-indexing", + }, + { + from: "/docs/hypersync/", + to: "/docs/HyperIndex/hypersync", + }, + { + from: "/docs/rpc-sync", + to: "/docs/HyperIndex/rpc-sync", + }, + { + from: "/docs/persisted_files", + to: "/docs/HyperIndex/persisted_files", + }, + { + from: "/docs/generated-files", + to: "/docs/HyperIndex/generated-files", + }, + { + from: "/docs/terminology", + to: "/docs/HyperIndex/terminology", + }, + { + from: "/docs/async-mode", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/HyperIndex/async-mode", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/labels", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/HyperIndex/labels", + to: "/docs/HyperIndex/overview", + }, + { + from: "/docs/performance", + to: "/docs/HyperIndex/performance", + }, + { + from: "/docs/example-sablier-v2", + to: "/docs/HyperIndex/example-sablier", + }, + { + from: "/docs/example-liquidation-metrics", + to: "/docs/HyperIndex/example-liquidation-metrics", + }, + { + from: "/docs/example-uniswap-v3", + to: "/docs/HyperIndex/example-uniswap-v4-multi-chain-indexer", + }, + { + from: "/docs/example-uniswap-v4", + to: "/docs/HyperIndex/example-uniswap-v4-multi-chain-indexer", + }, + { + from: "/docs/example-ens", + to: "/docs/HyperIndex/example-ens", + }, + { + from: "/docs/logging", + to: "/docs/HyperIndex/logging", + }, + { + from: "/docs/common-issues", + to: "/docs/HyperIndex/common-issues", + }, + { + from: "/docs/error-codes", + to: "/docs/HyperIndex/error-codes", + }, + { + from: "/docs/reserved-words", + to: "/docs/HyperIndex/reserved-words", + }, + { + from: "/docs/hyperfuel", + to: "/docs/HyperIndex/fuel", + }, + //// HyperSync + { + from: "/docs/overview-hypersync", + to: "/docs/HyperSync/overview", + }, + { + from: "/docs/hypersync-usage", + to: "/docs/HyperSync/hypersync-usage", + }, + { + from: "/docs/hypersync-query", + to: "/docs/HyperSync/hypersync-query", + }, + { + from: "/docs/hypersync-clients", + to: "/docs/HyperSync/hypersync-clients", + }, + { + from: "/docs/hypersync-curl-example", + to: "/docs/HyperSync/hypersync-curl-examples", + }, + { + from: "/docs/hypersync-url-endpoints", + to: "/docs/HyperSync/hypersync-supported-networks", + }, + { + from: "/docs/HyperSync/hypersync-url-endpoints", + to: "/docs/HyperSync/hypersync-supported-networks", + }, + { + from: "/docs/HyperSync/hyperrpc-url-endpoints", + to: "/docs/HyperSync/hyperrpc-supported-networks", + }, + { + from: "/docs/hyperfuel-query", + to: "/docs/HyperSync/hyperfuel-query", + }, + { + from: "/docs/overview-hyperrpc", + to: "/docs/HyperSync/overview-hyperrpc", + }, ]; /** @type {import('@docusaurus/types').Config} */ const config = { - title: "Envio", - tagline: "The fastest most flexible way to get on-chain data.", - favicon: "img/favicon.ico", - url: "https://docs.envio.dev", - baseUrl: "/", - organizationName: "enviodev", - projectName: "indexer-docs", - onBrokenLinks: "throw", - onBrokenMarkdownLinks: "warn", - i18n: { - defaultLocale: "en", - locales: ["en"], - }, - presets: [ - [ - "classic", - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ - docs: false, - blog: { - showReadingTime: true, - blogTitle: "Blog", - postsPerPage: 9, - blogSidebarTitle: "All posts", - blogSidebarCount: "ALL", - }, - theme: { - customCss: require.resolve("./src/css/custom.css"), - }, - gtag: { - trackingID: "G-J0WZ32ZV5B", - anonymizeIP: true, - }, - }), - ], - ], - - stylesheets: [ - { - href: "/custom.css", - type: "text/css", + title: "Envio", + tagline: "The fastest most flexible way to get on-chain data.", + favicon: "img/favicon.ico", + url: "https://docs.envio.dev", + baseUrl: "/", + organizationName: "enviodev", + projectName: "indexer-docs", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", + i18n: { + defaultLocale: "en", + locales: ["en"], }, - ], - - themeConfig: - /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + presets: [ + [ + "classic", + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: false, + blog: { + showReadingTime: true, + blogTitle: "Blog", + postsPerPage: 9, + blogSidebarTitle: "All posts", + blogSidebarCount: "ALL", + }, + theme: { + customCss: require.resolve("./src/css/custom.css"), + }, + gtag: { + trackingID: "G-J0WZ32ZV5B", + anonymizeIP: true, + }, + }), + ], + ], - ({ - image: "img/preview-banner.png", - colorMode: { - defaultMode: "dark", - disableSwitch: false, - respectPrefersColorScheme: true, - }, - announcementBar: { - id: "support_us", - content: - 'If you like Envio, give us a star on GitHub ⭐️', - backgroundColor: "#fafbfc", - textColor: "#091E42", - isCloseable: true, - }, - // Add custom CSS for smaller sidebar text - stylesheets: [ + stylesheets: [ { - href: "/custom.css", - type: "text/css", + href: "/custom.css", + type: "text/css", }, - ], - navbar: { - title: "", - logo: { - alt: "Envio Logo", - src: "img/envio-logo.png", - srcDark: "img/envio-logo.png", - style: { - maxWidth: 200, - maxHeight: 40, - }, - href: "https://envio.dev", - }, - items: [ - { - to: "docs/HyperIndex/overview", - label: "HyperIndex Docs", - position: "left", - }, - { - to: "docs/HyperSync/overview", - label: "HyperSync Docs", - position: "left", - }, - { - to: "showcase", - label: "Showcase", - position: "left", - }, - { - to: "blog", - label: "Blog", - position: "left", - }, - { - href: "https://github.com/enviodev", - label: "GitHub", - position: "right", - }, - ], - }, - algolia: { - apiKey: "0f966036bca0e26d512dc59f023d64c5", - indexName: "envio", - appId: "584MK2OMPZ", - contextualSearch: true, // algolia prioritizes results that are more related to the current section of the docs. - }, - footer: { - style: "dark", - links: [ - { - title: "Community", - items: [ - { label: "Discord", href: "https://discord.gg/Q9qt8gZ2fX" }, - { label: "Twitter", href: "https://twitter.com/envio_indexer" }, - { label: "Lens", href: "https://lenster.xyz/u/envio.lens" }, + ], + + themeConfig: + /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ + + ({ + image: "img/preview-banner.png", + colorMode: { + defaultMode: "dark", + disableSwitch: false, + respectPrefersColorScheme: true, + }, + announcementBar: { + id: "support_us", + content: + 'If you like Envio, give us a star on GitHub ⭐️', + backgroundColor: "#fafbfc", + textColor: "#091E42", + isCloseable: true, + }, + // Add custom CSS for smaller sidebar text + stylesheets: [ + { + href: "/custom.css", + type: "text/css", + }, ], - }, - { - title: "More", - items: [ - { - label: "Blog", - to: "blog", - }, - { - label: "GitHub", - href: "https://github.com/enviodev", - }, + navbar: { + title: "", + logo: { + alt: "Envio Logo", + src: "img/envio-logo.png", + srcDark: "img/envio-logo.png", + style: { + maxWidth: 200, + maxHeight: 40, + }, + href: "https://envio.dev", + }, + items: [ + { + to: "docs/HyperIndex/overview", + label: "HyperIndex Docs", + position: "left", + }, + { + to: "docs/HyperSync/overview", + label: "HyperSync Docs", + position: "left", + }, + { + to: "showcase", + label: "Showcase", + position: "left", + }, + { + to: "blog", + label: "Blog", + position: "left", + }, + { + href: "https://github.com/enviodev", + label: "GitHub", + position: "right", + }, + ], + }, + algolia: { + apiKey: "0f966036bca0e26d512dc59f023d64c5", + indexName: "envio", + appId: "584MK2OMPZ", + contextualSearch: true, // algolia prioritizes results that are more related to the current section of the docs. + }, + footer: { + style: "dark", + links: [ + { + title: "Community", + items: [ + { + label: "Discord", + href: "https://discord.gg/Q9qt8gZ2fX", + }, + { + label: "Twitter", + href: "https://twitter.com/envio_indexer", + }, + { + label: "Lens", + href: "https://lenster.xyz/u/envio.lens", + }, + ], + }, + { + title: "More", + items: [ + { + label: "Blog", + to: "blog", + }, + { + label: "GitHub", + href: "https://github.com/enviodev", + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} Envio`, + }, + prism: { + theme: lightCodeTheme, + darkTheme: darkCodeTheme, + additionalLanguages: [ + "rescript", + "bash", + "diff", + "json", + "javascript", + "typescript", + ], + }, + metadata: [ + { name: "twitter:card", content: "summary_large_image" }, + { name: "twitter:site", content: "@envio_indexer" }, + { property: "og:type", content: "website" }, + { property: "og:locale", content: "en" }, ], - }, + }), + plugins: [ + [ + "docusaurus-plugin-llms", + { + generateLLMsTxt: true, + generateLLMsFullTxt: true, + ignoreFiles: [ + "docs/HyperIndex-LLM/**", + "docs/HyperSync-LLM/**", + ], + tile: "Envio Docs", + description: + "The fastest most flexible way to get on-chain data.", + generateMarkdownFiles: false, + includeBlog: false, + excludeImports: true, + removeDuplicateHeadings: true, + includeOrder: [ + "docs/HyperIndex/overview.md", + "docs/HyperIndex/getting-started.md", + "docs/HyperIndex/contract-import.md", + "docs/HyperIndex/benchmarks.md", + "docs/HyperIndex/migration-guide.md", + "docs/HyperIndex/Guides/**", + "docs/HyperIndex/Examples/**", + "docs/HyperIndex/Hosted_Service/**", + "docs/HyperIndex/Tutorials/**", + "docs/HyperIndex/Advanced/**", + "docs/HyperIndex/Troubleshoot/**", + "docs/HyperIndex/supported-networks/**", + "docs/HyperIndex/fuel/**", + "docs/HyperSync/overview.md", + "docs/HyperSync/quickstart.md", + "docs/HyperSync/hypersync-usage.md", + "docs/HyperSync/hypersync-clients.md", + "docs/HyperSync/hypersync-query.md", + "docs/HyperSync/hypersync-presets.md", + "docs/HyperSync/hypersync-curl-examples.md", + "docs/HyperSync/api-tokens.mdx", + "docs/HyperSync/hypersync-supported-networks.md", + "docs/HyperSync/tutorial-address-transactions.md", + "docs/HyperSync/HyperRPC/**", + "docs/HyperSync/HyperFuel/**", + ], + customLLMFiles: [ + { + filename: "llms-hyperindex.txt", + includePatterns: ["docs/HyperIndex/**"], + fullContent: false, + title: "HyperIndex Docs", + description: "", + orderPatterns: [ + "overview.md", + "getting-started.md", + "contract-import.md", + "benchmarks.md", + "migration-guide.md", + "Guides/**", + "Examples/**", + "Hosted_Service/**", + "Tutorials/**", + "Advanced/**", + "Troubleshoot/**", + "supported-networks/**", + "fuel/**", + ], + }, + { + filename: "llms-hypersync.txt", + includePatterns: ["docs/HyperSync/**"], + fullContent: false, + title: "HyperSync Docs", + description: "", + orderPatterns: [ + "overview.md", + "quickstart.md", + "hypersync-usage.md", + "hypersync-clients.md", + "hypersync-query.md", + "hypersync-presets.md", + "hypersync-curl-examples.md", + "api-tokens.mdx", + "hypersync-supported-networks.md", + "tutorial-address-transactions.md", + "HyperRPC/**", + "HyperFuel/**", + ], + }, + ], + }, ], - copyright: `Copyright © ${new Date().getFullYear()} Envio`, - }, - prism: { - theme: lightCodeTheme, - darkTheme: darkCodeTheme, - additionalLanguages: [ - "rescript", - "bash", - "diff", - "json", - "javascript", - "typescript", + [ + "@docusaurus/plugin-content-docs", + { + id: "HyperSync", + path: "docs/HyperSync", + routeBasePath: "docs/HyperSync", + sidebarPath: require.resolve("./sidebarsHyperSync.js"), + editUrl: "https://github.com/enviodev/docs/edit/main/", + showLastUpdateAuthor: false, + showLastUpdateTime: false, + // versions: { + // current: { + // label: 'latest(4.0.0)', + // path: '4.0.0', + // }, + // }, + }, + ], + [ + "@docusaurus/plugin-content-docs", + { + id: "HyperIndex", + path: "docs/HyperIndex", + routeBasePath: "docs/HyperIndex", + sidebarPath: require.resolve("./sidebarsHyperIndex.js"), + editUrl: "https://github.com/enviodev/docs/edit/main/", + showLastUpdateAuthor: false, + showLastUpdateTime: false, + disableVersioning: true, + versions: { + current: { + label: "v2", + path: "", + }, + }, + }, + ], + [ + "@docusaurus/plugin-content-docs", + { + id: "HyperIndex-LLM", + path: "docs/HyperIndex-LLM", + routeBasePath: "docs/HyperIndex-LLM", + sidebarPath: require.resolve("./sidebarsHyperIndexLLM.js"), + editUrl: "https://github.com/enviodev/docs/edit/main/", + showLastUpdateAuthor: false, + showLastUpdateTime: false, + }, + ], + [ + "@docusaurus/plugin-content-docs", + { + id: "HyperSync-LLM", + path: "docs/HyperSync-LLM", + routeBasePath: "docs/HyperSync-LLM", + sidebarPath: require.resolve("./sidebarsHyperSyncLLM.js"), + editUrl: "https://github.com/enviodev/docs/edit/main/", + showLastUpdateAuthor: false, + showLastUpdateTime: false, + }, + ], + [ + "@docusaurus/plugin-client-redirects", + { + redirects: redirectsList, + }, ], - }, - metadata: [ - { name: "twitter:card", content: "summary_large_image" }, - { name: "twitter:site", content: "@envio_indexer" }, - { property: "og:type", content: "website" }, - { property: "og:locale", content: "en" }, - ], - }), - plugins: [ - [ - "@docusaurus/plugin-content-docs", - { - id: "HyperSync", - path: "docs/HyperSync", - routeBasePath: "docs/HyperSync", - sidebarPath: require.resolve("./sidebarsHyperSync.js"), - editUrl: "https://github.com/enviodev/docs/edit/main/", - showLastUpdateAuthor: false, - showLastUpdateTime: false, - // versions: { - // current: { - // label: 'latest(4.0.0)', - // path: '4.0.0', - // }, - // }, - }, - ], - [ - "@docusaurus/plugin-content-docs", - { - id: "HyperIndex", - path: "docs/HyperIndex", - routeBasePath: "docs/HyperIndex", - sidebarPath: require.resolve("./sidebarsHyperIndex.js"), - editUrl: "https://github.com/enviodev/docs/edit/main/", - showLastUpdateAuthor: false, - showLastUpdateTime: false, - disableVersioning: true, - versions: { - current: { - label: "v2", - path: "", - }, - }, - }, - ], - [ - "@docusaurus/plugin-content-docs", - { - id: "HyperIndex-LLM", - path: "docs/HyperIndex-LLM", - routeBasePath: "docs/HyperIndex-LLM", - sidebarPath: require.resolve("./sidebarsHyperIndexLLM.js"), - editUrl: "https://github.com/enviodev/docs/edit/main/", - showLastUpdateAuthor: false, - showLastUpdateTime: false, - }, - ], - [ - "@docusaurus/plugin-content-docs", - { - id: "HyperSync-LLM", - path: "docs/HyperSync-LLM", - routeBasePath: "docs/HyperSync-LLM", - sidebarPath: require.resolve("./sidebarsHyperSyncLLM.js"), - editUrl: "https://github.com/enviodev/docs/edit/main/", - showLastUpdateAuthor: false, - showLastUpdateTime: false, - }, - ], - [ - "@docusaurus/plugin-client-redirects", - { - redirects: redirectsList, - }, ], - ], - themes: ["docusaurus-json-schema-plugin"], + themes: ["docusaurus-json-schema-plugin"], }; module.exports = config; diff --git a/package.json b/package.json index c08ef9ec..cb10283e 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,8 @@ }, "devDependencies": { "@docusaurus/module-type-aliases": "^3.3.2", - "@docusaurus/types": "3.0.0" + "@docusaurus/types": "3.0.0", + "docusaurus-plugin-llms": "^0.2.2" }, "browserslist": { "production": [ diff --git a/supported-networks.json b/supported-networks.json index 58831e8e..4d8dfcd1 100644 --- a/supported-networks.json +++ b/supported-networks.json @@ -2,4 +2,4 @@ "supported-networks/any-evm-with-rpc", "supported-networks/local-anvil", "supported-networks/local-hardhat", - "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-20","supported-networks/chainweb-testnet-21","supported-networks/chainweb-testnet-22","supported-networks/chainweb-testnet-23","supported-networks/chainweb-testnet-24","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/damon","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/galadriel-devnet","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sentient-testnet","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unichain-sepolia","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} \ No newline at end of file + "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-21","supported-networks/chainweb-testnet-22","supported-networks/chainweb-testnet-24","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/damon","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/galadriel-devnet","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sentient-testnet","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unichain-sepolia","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 596e2b2c..66159cc6 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5092,6 +5092,13 @@ brace-expansion@^1.1.7: balanced-match "^1.0.0" concat-map "0.0.1" +brace-expansion@^2.0.1: + version "2.0.2" + resolved "https://registry.yarnpkg.com/brace-expansion/-/brace-expansion-2.0.2.tgz#54fc53237a613d854c7bd37463aad17df87214e7" + integrity sha512-Jt0vHyM+jmUBqojB7E1NIYadt0vI0Qxjxd2TErW94wDz+E2LAm5vKMXXwg6ZZBTHPuUlDgQHKXvjGBdfcF1ZDQ== + dependencies: + balanced-match "^1.0.0" + braces@^2.3.1: version "2.3.2" resolved "https://registry.yarnpkg.com/braces/-/braces-2.3.2.tgz#5979fd3f14cd531565e5fa2df1abfff1dfaee729" @@ -6804,6 +6811,15 @@ docusaurus-json-schema-plugin@^1.12.2: monaco-editor-webpack-plugin "^7.0.1" react-monaco-editor "^0.55.0" +docusaurus-plugin-llms@^0.2.2: + version "0.2.2" + resolved "https://registry.yarnpkg.com/docusaurus-plugin-llms/-/docusaurus-plugin-llms-0.2.2.tgz#3461e8295d18d4057cf0fbcf5e3feac561ea6fd1" + integrity sha512-DZlZ6cv9p5poFE00Qg78aurBNWhLa4o0VhH4kI33DUT0y4ydlFEJJbf8Bks9BuuGPFbY/Guebn+hRc2QymMImg== + dependencies: + gray-matter "^4.0.3" + minimatch "^9.0.3" + yaml "^2.8.1" + docusaurus@^1.14.7: version "1.14.7" resolved "https://registry.yarnpkg.com/docusaurus/-/docusaurus-1.14.7.tgz#f51858ab643b29ec52264d6dd85e0d629e5b3a4a" @@ -11405,6 +11421,13 @@ minimatch@3.1.2, minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1: dependencies: brace-expansion "^1.1.7" +minimatch@^9.0.3: + version "9.0.5" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.5.tgz#d74f9dd6b57d83d8e98cfb82133b03978bc929e5" + integrity sha512-G6T0ZX48xgozx7587koeX9Ys2NYy6Gmv//P89sEte9V9whIapMNF4idKxnW2QtCcLiTWlb/wfCabAtAFWhhBow== + dependencies: + brace-expansion "^2.0.1" + minimatch@~3.0.2: version "3.0.8" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.8.tgz#5e6a59bd11e2ab0de1cfb843eb2d82e546c321c1" @@ -16359,6 +16382,11 @@ yaml@^1.7.2: resolved "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz" integrity sha512-r3vXyErRCYJ7wg28yvBY5VSoAF8ZvlcW9/BwUzEtUsjvX/DKs24dIkuwjtuprwJJHsbyUbLApepYTR1BN4uHrg== +yaml@^2.8.1: + version "2.8.1" + resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.8.1.tgz#1870aa02b631f7e8328b93f8bc574fac5d6c4d79" + integrity sha512-lcYcMxX2PO9XMGvAJkJ3OsNMw+/7FKes7/hgerGUYWIoWu5j/+YQqcZr5JnPZWzOsEBgMbSbiSTn/dv/69Mkpw== + yamljs@^0.2.1: version "0.2.10" resolved "https://registry.yarnpkg.com/yamljs/-/yamljs-0.2.10.tgz#481cc7c25ca73af59f591f0c96e3ce56c757a40f" From 01886ce5b40e131e206387211505f1a233980793 Mon Sep 17 00:00:00 2001 From: Nikhil Bhintade <29760727+nikbhintade@users.noreply.github.com> Date: Fri, 3 Oct 2025 04:28:04 +0000 Subject: [PATCH 2/3] custom plugin to handle url structure of docs --- .../HyperRPC/hyperrpc-supported-networks.md | 2 + .../HyperSync/hypersync-supported-networks.md | 2 + docusaurus.config.js | 161 ++++++------- package.json | 1 + plugins/plugin-generate-llms.js | 217 ++++++++++++++++++ supported-networks.json | 2 +- yarn.lock | 19 ++ 7 files changed, 323 insertions(+), 81 deletions(-) create mode 100644 plugins/plugin-generate-llms.js diff --git a/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md b/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md index 830ff19b..e8368c10 100644 --- a/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md +++ b/docs/HyperSync/HyperRPC/hyperrpc-supported-networks.md @@ -39,8 +39,10 @@ Here is a table of the currently supported networks on HyperRPC and their respec | Bsc | 56 | https://bsc.rpc.hypersync.xyz or https://56.rpc.hypersync.xyz | | | Bsc Testnet | 97 | https://bsc-testnet.rpc.hypersync.xyz or https://97.rpc.hypersync.xyz | | | Celo | 42220 | https://celo.rpc.hypersync.xyz or https://42220.rpc.hypersync.xyz | | +| Chainweb Testnet 20 | 5920 | https://chainweb-testnet-20.rpc.hypersync.xyz or https://5920.rpc.hypersync.xyz | | | Chainweb Testnet 21 | 5921 | https://chainweb-testnet-21.rpc.hypersync.xyz or https://5921.rpc.hypersync.xyz | | | Chainweb Testnet 22 | 5922 | https://chainweb-testnet-22.rpc.hypersync.xyz or https://5922.rpc.hypersync.xyz | | +| Chainweb Testnet 23 | 5923 | https://chainweb-testnet-23.rpc.hypersync.xyz or https://5923.rpc.hypersync.xyz | | | Chainweb Testnet 24 | 5924 | https://chainweb-testnet-24.rpc.hypersync.xyz or https://5924.rpc.hypersync.xyz | | | Chiliz | 88888 | https://chiliz.rpc.hypersync.xyz or https://88888.rpc.hypersync.xyz | | | Citrea Testnet | 5115 | https://citrea-testnet.rpc.hypersync.xyz or https://5115.rpc.hypersync.xyz | | diff --git a/docs/HyperSync/hypersync-supported-networks.md b/docs/HyperSync/hypersync-supported-networks.md index 54fefd2f..3f18ab6a 100644 --- a/docs/HyperSync/hypersync-supported-networks.md +++ b/docs/HyperSync/hypersync-supported-networks.md @@ -47,8 +47,10 @@ If you are a network operator or user and would like improved service support or | Bsc | 56 | https://bsc.hypersync.xyz or https://56.hypersync.xyz | 🥉 | | | Bsc Testnet | 97 | https://bsc-testnet.hypersync.xyz or https://97.hypersync.xyz | 🎒 | | | Celo | 42220 | https://celo.hypersync.xyz or https://42220.hypersync.xyz | 🪨 | | +| Chainweb Testnet 20 | 5920 | https://chainweb-testnet-20.hypersync.xyz or https://5920.hypersync.xyz | 🪨 | | | Chainweb Testnet 21 | 5921 | https://chainweb-testnet-21.hypersync.xyz or https://5921.hypersync.xyz | 🪨 | | | Chainweb Testnet 22 | 5922 | https://chainweb-testnet-22.hypersync.xyz or https://5922.hypersync.xyz | 🪨 | | +| Chainweb Testnet 23 | 5923 | https://chainweb-testnet-23.hypersync.xyz or https://5923.hypersync.xyz | 🪨 | | | Chainweb Testnet 24 | 5924 | https://chainweb-testnet-24.hypersync.xyz or https://5924.hypersync.xyz | 🪨 | | | Chiliz | 88888 | https://chiliz.hypersync.xyz or https://88888.hypersync.xyz | 🪨 | | | Citrea Testnet | 5115 | https://citrea-testnet.hypersync.xyz or https://5115.hypersync.xyz | 🪨 | | diff --git a/docusaurus.config.js b/docusaurus.config.js index efb3d8dd..be57d6c5 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -234,7 +234,7 @@ const config = { title: "Envio", tagline: "The fastest most flexible way to get on-chain data.", favicon: "img/favicon.ico", - url: "https://docs.envio.dev", + url: "http://localhost:3000", baseUrl: "/", organizationName: "enviodev", projectName: "indexer-docs", @@ -403,95 +403,96 @@ const config = { }), plugins: [ [ - "docusaurus-plugin-llms", + require.resolve("./plugins/plugin-generate-llms"), { - generateLLMsTxt: true, - generateLLMsFullTxt: true, - ignoreFiles: [ - "docs/HyperIndex-LLM/**", - "docs/HyperSync-LLM/**", - ], - tile: "Envio Docs", - description: - "The fastest most flexible way to get on-chain data.", - generateMarkdownFiles: false, - includeBlog: false, - excludeImports: true, - removeDuplicateHeadings: true, - includeOrder: [ - "docs/HyperIndex/overview.md", - "docs/HyperIndex/getting-started.md", - "docs/HyperIndex/contract-import.md", - "docs/HyperIndex/benchmarks.md", - "docs/HyperIndex/migration-guide.md", - "docs/HyperIndex/Guides/**", - "docs/HyperIndex/Examples/**", - "docs/HyperIndex/Hosted_Service/**", - "docs/HyperIndex/Tutorials/**", - "docs/HyperIndex/Advanced/**", - "docs/HyperIndex/Troubleshoot/**", - "docs/HyperIndex/supported-networks/**", - "docs/HyperIndex/fuel/**", - "docs/HyperSync/overview.md", - "docs/HyperSync/quickstart.md", - "docs/HyperSync/hypersync-usage.md", - "docs/HyperSync/hypersync-clients.md", - "docs/HyperSync/hypersync-query.md", - "docs/HyperSync/hypersync-presets.md", - "docs/HyperSync/hypersync-curl-examples.md", - "docs/HyperSync/api-tokens.mdx", - "docs/HyperSync/hypersync-supported-networks.md", - "docs/HyperSync/tutorial-address-transactions.md", - "docs/HyperSync/HyperRPC/**", - "docs/HyperSync/HyperFuel/**", - ], - customLLMFiles: [ + filesConfigs: [ + { + main: true, // this will become llms.txt + name: "envio", + root: ` +# Envio + +> The fastest most flexible way to get on-chain data. + +This file contains links to documentation sections following the llmstxt.org standard. +`, + includeOrder: [ + "docs/HyperIndex/overview.md", + "docs/HyperIndex/getting-started.md", + "docs/HyperIndex/contract-import.md", + "docs/HyperIndex/benchmarks.md", + "docs/HyperIndex/migration-guide.md", + "docs/HyperIndex/Guides/**", + "docs/HyperIndex/Examples/**", + "docs/HyperIndex/Hosted_Service/**", + "docs/HyperIndex/Tutorials/**", + "docs/HyperIndex/Advanced/**", + "docs/HyperIndex/Troubleshoot/**", + "docs/HyperIndex/supported-networks/**", + "docs/HyperIndex/fuel/**", + "docs/HyperSync/overview.md", + "docs/HyperSync/quickstart.md", + "docs/HyperSync/hypersync-usage.md", + "docs/HyperSync/hypersync-clients.md", + "docs/HyperSync/hypersync-query.md", + "docs/HyperSync/hypersync-presets.md", + "docs/HyperSync/hypersync-curl-examples.md", + "docs/HyperSync/api-tokens.mdx", + "docs/HyperSync/hypersync-supported-networks.md", + "docs/HyperSync/tutorial-address-transactions.md", + "docs/HyperSync/HyperRPC/**", + "docs/HyperSync/HyperFuel/**", + ], + }, { - filename: "llms-hyperindex.txt", - includePatterns: ["docs/HyperIndex/**"], - fullContent: false, - title: "HyperIndex Docs", - description: "", - orderPatterns: [ - "overview.md", - "getting-started.md", - "contract-import.md", - "benchmarks.md", - "migration-guide.md", - "Guides/**", - "Examples/**", - "Hosted_Service/**", - "Tutorials/**", - "Advanced/**", - "Troubleshoot/**", - "supported-networks/**", - "fuel/**", + name: "hyperindex", + root: ` +# HyperIndex Docs + +> HyperIndex description +`, + includeOrder: [ + "docs/HyperIndex/overview.md", + "docs/HyperIndex/getting-started.md", + "docs/HyperIndex/contract-import.md", + "docs/HyperIndex/benchmarks.md", + "docs/HyperIndex/migration-guide.md", + "docs/HyperIndex/Guides/**", + "docs/HyperIndex/Examples/**", + "docs/HyperIndex/Hosted_Service/**", + "docs/HyperIndex/Tutorials/**", + "docs/HyperIndex/Advanced/**", + "docs/HyperIndex/Troubleshoot/**", + "docs/HyperIndex/supported-networks/**", + "docs/HyperIndex/fuel/**", ], }, { - filename: "llms-hypersync.txt", - includePatterns: ["docs/HyperSync/**"], - fullContent: false, - title: "HyperSync Docs", - description: "", - orderPatterns: [ - "overview.md", - "quickstart.md", - "hypersync-usage.md", - "hypersync-clients.md", - "hypersync-query.md", - "hypersync-presets.md", - "hypersync-curl-examples.md", - "api-tokens.mdx", - "hypersync-supported-networks.md", - "tutorial-address-transactions.md", - "HyperRPC/**", - "HyperFuel/**", + name: "hypersync", + root: ` +# HyperSync Docs + +> HyperIndex description +`, + includeOrder: [ + "docs/HyperSync/overview.md", + "docs/HyperSync/quickstart.md", + "docs/HyperSync/hypersync-usage.md", + "docs/HyperSync/hypersync-clients.md", + "docs/HyperSync/hypersync-query.md", + "docs/HyperSync/hypersync-presets.md", + "docs/HyperSync/hypersync-curl-examples.md", + "docs/HyperSync/api-tokens.mdx", + "docs/HyperSync/hypersync-supported-networks.md", + "docs/HyperSync/tutorial-address-transactions.md", + "docs/HyperSync/HyperRPC/**", + "docs/HyperSync/HyperFuel/**", ], }, ], }, ], + [ "@docusaurus/plugin-content-docs", { diff --git a/package.json b/package.json index cb10283e..e854c525 100644 --- a/package.json +++ b/package.json @@ -35,6 +35,7 @@ "clsx": "^1.2.1", "docusaurus": "^1.14.7", "docusaurus-json-schema-plugin": "^1.12.2", + "minimatch": "^10.0.3", "prism-react-renderer": "^2.1.0", "react": "^18.2.0", "react-dom": "^18.2.0" diff --git a/plugins/plugin-generate-llms.js b/plugins/plugin-generate-llms.js new file mode 100644 index 00000000..c7dcd88b --- /dev/null +++ b/plugins/plugin-generate-llms.js @@ -0,0 +1,217 @@ +const fs = require("fs"); +const path = require("path"); +const matter = require("gray-matter"); +const glob = require("glob"); +const { minimatch } = require("minimatch"); + +// Docusaurus Plugin: Generate LLMS files +// -------------------------------------- +// This plugin generates `llms.txt` (and optional variants) during the Docusaurus build. +// It is designed for integrating with LLMs or tools that need a structured list of docs +// in text/Markdown format. +// +// What it does: +// 1. Scans all docs from `@docusaurus/plugin-content-docs`. +// 2. Collects metadata (title, slug, description, URL). +// 3. Orders docs according to `includeOrder` patterns (glob-like). +// 4. Writes an `llms.txt` file (or multiple) into the build output folder. +// 5. Optionally writes stripped-down `.md` copies of the docs (without frontmatter). +// +// How to use: +// ----------- +// In your `docusaurus.config.js`, add the plugin with configuration: +// +// plugins: [ +// [ +// require.resolve("./plugins/generate-llms"), // path to this plugin file +// { +// filesConfigs: [ +// { +// main: true, // Marks this as the main config +// name: "default", // Identifier (used for filename if not main) +// root: "Welcome to the docs!",// Text that appears at the top of llms.txt +// includeOrder: [ // Order of docs (glob patterns) +// "**/intro.md", +// "**/getting-started.md", +// "**/guides/*", +// ], +// }, +// { +// main: false, // Optional secondary config +// name: "advanced", // Will output as llms-advanced.txt +// root: "Advanced Topics", // Intro text +// includeOrder: [ +// "**/advanced/*", +// "**/api/*", +// ], +// }, +// ], +// }, +// ], +// ], +// +// Output: +// ------- +// - `build/llms.txt` (main file, always generated if `main: true` exists). +// - `build/llms-.txt` (for secondary configs). +// - `build/.../*.md` stripped copies of docs (only for the main config). +// +// Notes: +// - Paths in `includeOrder` are matched against doc file paths, so you can use wildcards. +// - The `.md` copies are saved at the same relative path as the doc's URL. + +function GenerateLLMSPlugin(context, options) { + return { + name: "docusaurus-plugin-generate-llms", + + async postBuild({ siteConfig }) { + const { url, plugins } = siteConfig; + + const filesConfigs = options.filesConfigs || []; + + let collectedDocs = []; + + // 1. collect docs metadata + for (const plugin of plugins) { + if ( + Array.isArray(plugin) && + plugin[0] === "@docusaurus/plugin-content-docs" + ) { + const config = plugin[1]; + const docsPath = path.resolve(config.path); + const routeBasePath = config.routeBasePath || ""; + + const allFiles = glob.sync("**/*.{md,mdx}", { + cwd: docsPath, + }); + + for (const file of allFiles) { + const fullPath = path.join(docsPath, file); + const raw = fs.readFileSync(fullPath, "utf-8"); + const parsed = matter(raw); + + const slug = parsed.data.slug; + const title = parsed.data.title; + const description = parsed.data.description || ""; + + if (!slug || !title) continue; + + const pageUrl = `${url.replace( + /\/$/, + "" + )}/${routeBasePath.replace(/^\//, "")}/${slug.replace( + /^\//, + "" + )}`; + + collectedDocs.push({ + filePath: path.join(config.path, file), + title, + description, + pageUrl, + }); + } + } + } + + // Helper to convert Windows paths to POSIX + function toPosix(p) { + return p.split(path.sep).join("/"); + } + + function orderDocs(includeOrder) { + if (!includeOrder || includeOrder.length === 0) { + return []; + } + + const matched = new Set(); + const ordered = []; + const duplicates = new Set(); + + for (const pattern of includeOrder) { + for (const doc of collectedDocs) { + const docPath = toPosix(doc.filePath); + const pat = toPosix(pattern); + + if (minimatch(docPath, pat)) { + if (matched.has(doc.filePath)) { + duplicates.add(doc.filePath); + } else { + ordered.push(doc); + matched.add(doc.filePath); + } + } + } + } + + return ordered; + } + + function renderLLMS(rootText, docs) { + let output = rootText.trim() + "\n\n"; + for (const doc of docs) { + const desc = + doc.description || + (doc.title.length > 20 + ? `${doc.title} section of the docs.` + : ""); + output += `- [${doc.title}](${doc.pageUrl}.md): ${desc}\n`; + } + return output; + } + + // --- NEW: write .md copies into build folder --- + function writeMarkdownCopies(docs) { + for (const doc of docs) { + const rawContent = fs.readFileSync(doc.filePath, "utf-8"); + + // Use gray-matter to strip frontmatter + const parsed = matter(rawContent); + const cleanContent = parsed.content.trimStart(); + + // Convert pageUrl to relative path inside build + let relativePath = doc.pageUrl.replace( + siteConfig.url.replace(/\/$/, ""), + "" + ); + relativePath = relativePath.replace(/^\//, ""); + + // Save as .md file (same path as page, but with .md) + const targetPath = path.join( + context.outDir, + `${relativePath}.md` + ); + + fs.mkdirSync(path.dirname(targetPath), { recursive: true }); + fs.writeFileSync(targetPath, cleanContent, "utf-8"); + } + } + + // 2. generate files + for (const cfg of filesConfigs) { + const { main, name, root = "", includeOrder = [] } = cfg; + + // Order docs based on includeOrder patterns + const orderedDocs = orderDocs(includeOrder); + + // Inject "## Table of Contents" after root text + const tocRoot = root.trim() + "\n\n## Table of Contents\n"; + + const output = renderLLMS(tocRoot, orderedDocs); + + // Use llms.txt for the first/main config, others as llms-.txt + const outFileName = cfg.main ? "llms.txt" : `llms-${name}.txt`; + const outPath = path.join(context.outDir, outFileName); + + fs.writeFileSync(outPath, output, "utf-8"); + + // ✅ Only run markdown copy for main config + if (main) { + writeMarkdownCopies(orderedDocs); + } + } + }, + }; +} + +module.exports = GenerateLLMSPlugin; diff --git a/supported-networks.json b/supported-networks.json index 4d8dfcd1..58831e8e 100644 --- a/supported-networks.json +++ b/supported-networks.json @@ -2,4 +2,4 @@ "supported-networks/any-evm-with-rpc", "supported-networks/local-anvil", "supported-networks/local-hardhat", - "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-21","supported-networks/chainweb-testnet-22","supported-networks/chainweb-testnet-24","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/damon","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/galadriel-devnet","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sentient-testnet","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unichain-sepolia","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} \ No newline at end of file + "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-20","supported-networks/chainweb-testnet-21","supported-networks/chainweb-testnet-22","supported-networks/chainweb-testnet-23","supported-networks/chainweb-testnet-24","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/damon","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/galadriel-devnet","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sentient-testnet","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unichain-sepolia","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} \ No newline at end of file diff --git a/yarn.lock b/yarn.lock index 66159cc6..e61bbd12 100644 --- a/yarn.lock +++ b/yarn.lock @@ -2683,6 +2683,18 @@ resolved "https://registry.yarnpkg.com/@headlessui/tailwindcss/-/tailwindcss-0.2.1.tgz#1becc201f69358a40e08bd676acc234b2cabe6e4" integrity sha512-2+5+NZ+RzMyrVeCZOxdbvkUSssSxGvcUxphkIfSVLpRiKsj+/63T2TOL9dBYMXVfj/CGr6hMxSRInzXv6YY7sA== +"@isaacs/balanced-match@^4.0.1": + version "4.0.1" + resolved "https://registry.yarnpkg.com/@isaacs/balanced-match/-/balanced-match-4.0.1.tgz#3081dadbc3460661b751e7591d7faea5df39dd29" + integrity sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ== + +"@isaacs/brace-expansion@^5.0.0": + version "5.0.0" + resolved "https://registry.yarnpkg.com/@isaacs/brace-expansion/-/brace-expansion-5.0.0.tgz#4b3dabab7d8e75a429414a96bd67bf4c1d13e0f3" + integrity sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA== + dependencies: + "@isaacs/balanced-match" "^4.0.1" + "@jest/schemas@^29.6.3": version "29.6.3" resolved "https://registry.npmjs.org/@jest/schemas/-/schemas-29.6.3.tgz" @@ -11421,6 +11433,13 @@ minimatch@3.1.2, minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.1: dependencies: brace-expansion "^1.1.7" +minimatch@^10.0.3: + version "10.0.3" + resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-10.0.3.tgz#cf7a0314a16c4d9ab73a7730a0e8e3c3502d47aa" + integrity sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw== + dependencies: + "@isaacs/brace-expansion" "^5.0.0" + minimatch@^9.0.3: version "9.0.5" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.5.tgz#d74f9dd6b57d83d8e98cfb82133b03978bc929e5" From 73ca7f071da766dcc6937c9ef067f4ac30b613d6 Mon Sep 17 00:00:00 2001 From: Nikhil Bhintade <29760727+nikbhintade@users.noreply.github.com> Date: Fri, 3 Oct 2025 06:04:31 +0000 Subject: [PATCH 3/3] llms.txt modification --- docusaurus.config.js | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 6bf96d42..0d511488 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -415,9 +415,10 @@ const config = { main: true, // this will become llms.txt name: "envio", root: ` -# Envio +# Envio: Fast, Multi-Chain Blockchain Indexer + +> Envio.dev is a high-performance, multi-chain blockchain indexing framework designed for developers. It offers real-time and historical data querying via GraphQL APIs, supports automatic reorg handling, and enables rapid deployment with zero-downtime rollbacks. Built for EVM-compatible chains and Fuel, Envio empowers developers to build scalable blockchain applications efficiently. -> The fastest most flexible way to get on-chain data. This file contains links to documentation sections following the llmstxt.org standard. `, @@ -445,8 +446,9 @@ This file contains links to documentation sections following the llmstxt.org sta "docs/HyperSync/api-tokens.mdx", "docs/HyperSync/hypersync-supported-networks.md", "docs/HyperSync/tutorial-address-transactions.md", - "docs/HyperSync/HyperRPC/**", "docs/HyperSync/HyperFuel/**", + "docs/HyperRPC/overview-hyperrpc.md", + "docs/HyperRPC/hyperrpc-supported-networks.md", ], }, { @@ -454,7 +456,9 @@ This file contains links to documentation sections following the llmstxt.org sta root: ` # HyperIndex Docs -> HyperIndex description +> HyperIndex is a complete indexing framework with schema management, event handling, and GraphQL APIs. + +This file contains links to documentation sections following the llmstxt.org standard. `, includeOrder: [ "docs/HyperIndex/overview.md", @@ -477,7 +481,9 @@ This file contains links to documentation sections following the llmstxt.org sta root: ` # HyperSync Docs -> HyperIndex description +> HyperSync is Envio's high-performance blockchain data engine that serves as a direct replacement for traditional RPC endpoints, delivering up to 2000x faster data access. + +This file contains links to documentation sections following the llmstxt.org standard. `, includeOrder: [ "docs/HyperSync/overview.md", @@ -490,10 +496,23 @@ This file contains links to documentation sections following the llmstxt.org sta "docs/HyperSync/api-tokens.mdx", "docs/HyperSync/hypersync-supported-networks.md", "docs/HyperSync/tutorial-address-transactions.md", - "docs/HyperSync/HyperRPC/**", "docs/HyperSync/HyperFuel/**", ], }, + { + name: "hyperrpc", + root: ` +# HyperRPC Docs + +> HyperRPC is an extremely fast read-only RPC designed specifically for data-intensive blockchain tasks. It provides simple drop-in replacement for existing RPC-based code. + +This file contains links to documentation sections following the llmstxt.org standard. +`, + includeOrder: [ + "docs/HyperRPC/overview-hyperrpc.md", + "docs/HyperRPC/hyperrpc-supported-networks.md", + ], + }, ], }, ],