Skip to content

Commit

Permalink
📝 Docs: updates (#1357)
Browse files Browse the repository at this point in the history 
## 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:

Co-authored-by: William Cory <[email protected]>
  • Loading branch information
@roninjin10
roninjin10 and William Cory authored Aug 1, 2024
1 parent 43e13e8 commit 38ba69d
Show file tree
Hide file tree
Showing 8 changed files with 129 additions and 124 deletions.
219 changes: 112 additions & 107 deletions docs/astro.config.mjs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,111 +8,116 @@ const ENABLE_LINK_CHECKER = false

// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
lastUpdated: true,
customCss: ['./src/styles/custom.css'],
editLink: {
baseUrl: 'https://github.com/evmts/tevm-monorepo/edit/main/docs',
},
tableOfContents: true,
plugins: [
...(ENABLE_LINK_CHECKER
? [
starlightLinksValidatorPlugin({
errorOnRelativeLinks: true,
}),
]
: []),
starlightTypeDoc({
entryPoints: [
'../packages/actions',
'../packages/base-client',
'../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/procedures',
'../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,
],
}),
],
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: [
...(ENABLE_LINK_CHECKER
? [
starlightLinksValidatorPlugin({
errorOnRelativeLinks: true,
}),
]
: []),
starlightTypeDoc({
entryPoints: [
'../packages/actions',
'../packages/base-client',
'../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/procedures',
'../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,
],
}),
],
})
Binary file added docs/src/assets/helloworld.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/src/assets/logo.webp
View file
Binary file not shown.
Binary file added docs/src/assets/tevm-logo-dark.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/tevm-logo-light.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/src/assets/tevm-logo.webp
View file
Binary file not shown.
Binary file added docs/src/assets/tevmexample.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 17 additions & 17 deletions docs/src/content/docs/index.mdx
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: Tevm docs
description: A complete toolset to build Ethereum applications in JavaScript
template: splash
template: doc
banner:
content: |
Follow our new twitter account
<a href="https://x.com/tevmtools">@tevmtools</a>
hero:
tagline: A complete toolset to build Ethereum applications in JavaScript
tagline: Next-generation toolset for building Ethereum applications in TypeScript
actions:
- text: Getting Started
- text: Tutorial
link: /getting-started/getting-started/
icon: right-arrow
variant: primary
- text: Reference
link: /learn/reference
icon: right-arrow
variant: primary
variant: secondary
- text: Quick start
link: https://stackblitz.com/~/github.com/evmts/quick-start?file=README.md
icon: right-arrow
Expand All @@ -21,6 +21,15 @@ hero:

import { Card, CardGrid } from '@astrojs/starlight/components';

## [Try now on Stackblitz!](https://stackblitz.com/~/github.com/evmts/quick-start?file=src/fsPrecompile.ts:L5)

- Select `> Typescript: Select Typescript version: Use Workspace Version` in the editor to enable the Tevm compiler upon opening the stackblitz.
- For best results [open in stackblitz](https://stackblitz.com/github/evmts/quick-start/tree/main?embed=1&file=src/main.ts&hideNavigation=1&hideDevTools=true&terminalHeight=0&ctl=1)

<div height="500">
<iframe style="frameborder: 0; width:100%; height: 500px;" src="https://stackblitz.com/github/evmts/quick-start/tree/main?embed=1&file=src/main.ts&hideNavigation=1&hideDevTools=true&terminalHeight=0&ctl=1"></iframe>
</div>

## Features

<CardGrid>
Expand All @@ -41,12 +50,3 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
</Card>
</CardGrid>

## [Try now on Stackblitz!](https://stackblitz.com/~/github.com/evmts/quick-start?file=src/fsPrecompile.ts:L5)

- Select `> Typescript: Select Typescript version: Use Workspace Version` in the editor to enable the Tevm compiler upon opening the stackblitz.
= Tevm compiler with solidity compilation only works in the [stackblitz beta environment](https://stackblitz.com/github/evmts/quick-start/tree/main?embed=1&file=src/main.ts&hideNavigation=1&hideDevTools=true&terminalHeight=0&ctl=1)

<div height="500">
<iframe style="frameborder: 0; width:100%; height: 500px;" src="https://stackblitz.com/github/evmts/quick-start/tree/main?embed=1&file=src/main.ts&hideNavigation=1&hideDevTools=true&terminalHeight=0&ctl=1"></iframe>
</div>

0 comments on commit 38ba69d

Please sign in to comment.