-
-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🐛 Fix: generate sidebar for consistent sidebar (#1488)
## Description _Concise description of proposed changes_ ## Testing Explain the quality checks that have been done on the code changes ## Additional Information - [ ] I read the [contributing docs](../docs/contributing.md) (if this is your first contribution) Your ENS/address: <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Release Notes - **New Features** - Introduced a sidebar configuration for improved navigation in documentation. - Added new documentation files for enhanced clarity on using Tevm with Solidity. - New script for generating sidebar configuration based on markdown files. - **Documentation Updates** - Enhanced several documents with new sections and examples to improve user understanding of Tevm functionalities. - Updated metadata for various documents to improve organization and navigation. - **Bug Fixes** - Removed deprecated constants and plugins from the configuration to streamline setup. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
- Loading branch information
1 parent
e605859
commit af75280
Showing
17 changed files
with
443 additions
and
275 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,124 +1,9 @@ | ||
| import starlight from '@astrojs/starlight' | ||
| import { defineConfig } from 'astro/config' | ||
| import starlightBlogPlugin from 'starlight-blog' | ||
| import starlightLinksValidatorPlugin from 'starlight-links-validator' | ||
| import starlightTypeDoc, { typeDocSidebarGroup } from 'starlight-typedoc' | ||
|
|
||
| // TODO fix this | ||
| const ENABLE_LINK_CHECKER = false | ||
| import { defineConfig } from 'astro/config'; | ||
| import { starlightConfig } from './astro.starlight.config.mjs'; | ||
|
|
||
| // https://astro.build/config | ||
| export default defineConfig({ | ||
| integrations: [ | ||
| starlight({ | ||
| logo: { | ||
| light: './src/assets/tevm-logo-light.png', | ||
| dark: './src/assets/tevm-logo-dark.png', | ||
| }, | ||
| lastUpdated: true, | ||
| customCss: ['./src/styles/custom.css'], | ||
| editLink: { | ||
| baseUrl: 'https://github.com/evmts/tevm-monorepo/edit/main/docs', | ||
| }, | ||
| tableOfContents: true, | ||
| favicon: './src/assets/tevm-logo-dark.png', | ||
| plugins: [ | ||
| starlightBlogPlugin(), | ||
| ...(ENABLE_LINK_CHECKER | ||
| ? [ | ||
| starlightLinksValidatorPlugin({ | ||
| errorOnRelativeLinks: true, | ||
| }), | ||
| ] | ||
| : []), | ||
| starlightTypeDoc({ | ||
| entryPoints: [ | ||
| '../packages/actions', | ||
| '../packages/node', | ||
| '../packages/block', | ||
| '../packages/blockchain', | ||
| '../packages/client-types', | ||
| '../packages/common', | ||
| '../packages/contract', | ||
| '../packages/decorators', | ||
| '../packages/evm', | ||
| '../packages/errors', | ||
| '../extensions/ethers', | ||
| '../packages/evm', | ||
| '../packages/http-client', | ||
| '../packages/jsonrpc', | ||
| '../packages/logger', | ||
| '../packages/memory-client', | ||
| '../packages/precompiles/', | ||
| '../packages/predeploys', | ||
| '../packages/receipt-manager', | ||
| '../packages/rlp', | ||
| '../packages/server', | ||
| '../packages/state', | ||
| '../packages/sync-storage-persister', | ||
| '../test/test-utils', | ||
| '../packages/trie', | ||
| '../packages/tx', | ||
| '../packages/txpool', | ||
| '../packages/utils', | ||
| '../extensions/viem', | ||
| '../packages/vm', | ||
| '../bundler-packages/base-bundler', | ||
| '../bundler-packages/bun', | ||
| '../bundler-packages/bundler-cache', | ||
| '../bundler-packages/compiler', | ||
| '../bundler-packages/config', | ||
| '../bundler-packages/esbuild', | ||
| '../packages/address', | ||
| '../packages/effect', | ||
| '../bundler-packages/resolutions', | ||
| '../bundler-packages/rollup', | ||
| '../bundler-packages/rspack', | ||
| '../bundler-packages/runtime', | ||
| '../bundler-packages/solc', | ||
| '../bundler-packages/unplugin', | ||
| '../bundler-packages/ts-plugin', | ||
| '../bundler-packages/vite', | ||
| '../bundler-packages/webpack', | ||
| ], | ||
| tsconfig: '../tevm/tsconfig.json', | ||
| output: 'reference', | ||
| sidebar: { | ||
| label: 'Reference (auto-generated)', | ||
| collapsed: true, | ||
| }, | ||
| typeDoc: { | ||
| gitRevision: 'main', | ||
| entryPointStrategy: 'packages', | ||
| }, | ||
| }), | ||
| ], | ||
| title: 'Tevm Docs', | ||
| social: { | ||
| github: 'https://github.com/evmts/tevm-monorepo', | ||
| twitter: 'https://twitter.com/FUCORY', | ||
| telegram: 'https://t.me/+ANThR9bHDLAwMjUx', | ||
| }, | ||
| sidebar: [ | ||
| { | ||
| label: 'Getting Started', | ||
| items: [{ label: 'Getting Started Guide', link: '/getting-started/getting-started/' }], | ||
| }, | ||
| { | ||
| label: 'Learn', | ||
| items: [ | ||
| { label: 'Clients', link: '/learn/clients/' }, | ||
| { label: 'Actions', link: '/learn/actions/' }, | ||
| { label: 'Low-level API', link: '/learn/low-level-api/' }, | ||
| { label: 'JSON RPC', link: '/learn/json-rpc/' }, | ||
| { label: 'Contracts', link: '/learn/contracts/' }, | ||
| { label: 'Bundler', link: '/learn/solidity-imports/' }, | ||
| { label: 'Advanced Scripting', link: '/learn/scripting/' }, | ||
| { label: 'Reference', link: '/learn/reference/' }, | ||
| ], | ||
| }, | ||
| typeDocSidebarGroup, | ||
| ], | ||
| }), | ||
| starlightConfig, | ||
| ], | ||
| }) | ||
| }); |
Oops, something went wrong.