Skip to content

Commit 70c6813

Browse files
tac0turtletac0turtlegithub-advanced-security[bot]gemini-code-assist[bot]
authored
chore: merge docs repo into this repo (#2526)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. NOTE: PR titles should follow semantic commits: https://www.conventionalcommits.org/en/v1.0.0/ --> ## Overview merging docs into here in order to create a mono repo so its easier to keep things updated when we make changes here --------- Co-authored-by: tac0turtle <[email protected]> Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
1 parent d0d7b05 commit 70c6813

File tree

146 files changed

+10323
-311
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

146 files changed

+10323
-311
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ body:
1212
label: Version Information
1313
description: Please provide versions of all relevant components
1414
placeholder: |
15-
Rollkit:
15+
ev-node:
1616
Execution Implementation:
1717
validations:
1818
required: true
@@ -112,7 +112,7 @@ body:
112112
description: |
113113
Please provide relevant logs from different components:
114114
- Node logs
115-
- Rollkit logs
115+
- Ev-node logs
116116
- DA logs
117117
- Sequencer logs
118118
- Execution logs

.github/workflows/build_docs.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Build VitePress Site
2+
permissions:
3+
contents: read
4+
5+
on:
6+
push:
7+
branches: [main]
8+
paths:
9+
- "./docs"
10+
pull_request:
11+
paths:
12+
- "./docs"
13+
14+
jobs:
15+
build:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout
19+
uses: actions/checkout@v4
20+
- name: Setup Node
21+
uses: actions/setup-node@v4
22+
with:
23+
node-version: 20
24+
cache: yarn # or pnpm / npm
25+
- name: Install dependencies
26+
run: yarn install # or pnpm install / npm ci
27+
- name: Build with VitePress
28+
run: yarn build # or pnpm build / npm build

.github/workflows/deploy_docs.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Sample workflow for building and deploying a VitePress site to GitHub Pages
2+
#
3+
name: Deploy VitePress site to Pages
4+
5+
on:
6+
# Runs on pushes targeting the `main` branch. Change this to `master` if you're
7+
# using the `master` branch as the default branch.
8+
push:
9+
branches: [main]
10+
paths:
11+
- "./docs"
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions: write-all
18+
19+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
20+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
21+
concurrency:
22+
group: pages
23+
cancel-in-progress: false
24+
25+
jobs:
26+
# Build job
27+
build:
28+
runs-on: ubuntu-latest
29+
steps:
30+
- name: Checkout
31+
uses: actions/checkout@v4
32+
with:
33+
fetch-depth: 0 # Not needed if lastUpdated is not enabled
34+
# - uses: pnpm/action-setup@v2 # Uncomment this if you're using pnpm
35+
- name: Setup Node
36+
uses: actions/setup-node@v4
37+
with:
38+
node-version: 20
39+
cache: yarn # or pnpm / npm
40+
- name: Setup Pages
41+
uses: actions/configure-pages@v5
42+
- name: Install dependencies
43+
run: yarn install # or pnpm install / npm ci
44+
- name: Build with VitePress
45+
run: yarn build # or pnpm build / npm build
46+
- name: Deploy to GitHub Pages
47+
uses: peaceiris/actions-gh-pages@v4
48+
with:
49+
github_token: ${{ secrets.GITHUB_TOKEN }}
50+
publish_dir: ./.vitepress/dist
51+
cname: ev.xyz

.github/workflows/preview_docs.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Deploy PR previews
2+
3+
on:
4+
# This workflow requires pull_request and won't work with pull_request_target
5+
# due to github permissions
6+
pull_request:
7+
types:
8+
- opened
9+
- reopened
10+
- synchronize
11+
- closed
12+
paths:
13+
- "./docs"
14+
15+
concurrency: preview-${{ github.ref }}
16+
17+
jobs:
18+
deploy-preview:
19+
if: github.actor != 'dependabot[bot]'
20+
runs-on: ubuntu-latest
21+
permissions: write-all
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Setup Node
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: 20
30+
cache: yarn
31+
32+
- name: Install dependencies
33+
run: yarn install --frozen-lockfile
34+
35+
- name: Build with Base URL
36+
run: BASE='/docs-preview/pr-${{ github.event.number }}/' yarn build
37+
38+
- name: Deploy preview
39+
uses: rossjrw/pr-preview-action@v1
40+
with:
41+
source-dir: .vitepress/dist
42+
deploy-repository: evstack/docs-preview
43+
token: ${{ secrets.PREVIEW_DEPLOY }}
44+
preview-branch: main
45+
umbrella-dir: .

.gitignore

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,14 @@ build
1414
.DS_Store
1515
coverage.out
1616
execution/evm/jwttoken
17-
target
17+
target
18+
19+
docs/.vitepress/dist
20+
node_modules
21+
docs/.vitepress/cache
22+
*.log
23+
*.tgz
24+
.idea
25+
.temp
26+
.vite_opt_cache
27+
.vscode

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Finding an issue
44

5-
GitHub issues are used to track the work associated with Rollkit. That's where you can find things to work on.
5+
GitHub issues are used to track the work associated with Evolve. That's where you can find things to work on.
66

77
Issue labels have been used to help designate the priority, status and beginner-friendliness of various issues. Here are some of the ones that are most relevant to finding a good issue to work on:
88

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,4 @@ make proto-lint
100100
| 2024/01/12 | [Informal Systems](https://informal.systems/) | [eccdd...bcb9d](https://github.com/evstack/ev-node/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d) | [informal-systems.pdf](docs/audit/informal-systems.pdf) |
101101
| 2024/01/10 | [Binary Builders](https://binary.builders/) | [eccdd...bcb9d](https://github.com/evstack/ev-node/commit/eccdd0f1793a5ac532011ef4d896de9e0d8bcb9d) | [binary-builders.pdf](docs/audit/binary-builders.pdf) |
102102

103-
[docs]: <https://rollkit.dev> <!-- todo rename once we have the domain-->
103+
[docs]: <https://ev.xyz>

RELEASE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document outlines the release process for all Go packages in the ev-node re
44

55
## Package Dependency Graph
66

7-
```ascii
7+
```txt
88
┌──────────┐
99
│ core │ (zero dependencies)
1010
└────┬─────┘

apps/evm/based/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Rollkit EVM Based Sequencer
1+
# Evolve EVM Based Sequencer
22

3-
This directory contains the implementation of a based EVM sequencer using Rollkit.
3+
This directory contains the implementation of a based EVM sequencer using Evolve.
44

55
## Prerequisites
66

@@ -12,7 +12,7 @@ This directory contains the implementation of a based EVM sequencer using Rollki
1212

1313
1. Both EVM and DA layers must be running before starting the aggregator
1414
1. For the EVM layer, Reth can be conveniently run using `docker compose` from the go-execution-evm repository.
15-
2. For the DA layer, local-da can be built and run from the `rollkit/da/cmd/local-da` directory.
15+
2. For the DA layer, local-da can be built and run from the `ev-node/da/cmd/local-da` directory.
1616

1717
2. Build the sequencer:
1818

apps/evm/based/cmd/init.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ import (
1111
rollgenesis "github.com/evstack/ev-node/pkg/genesis"
1212
)
1313

14-
// InitCmd initializes a new rollkit.yaml file in the current directory
14+
// InitCmd initializes a new evolve.yaml file in the current directory
1515
func InitCmd() *cobra.Command {
1616
initCmd := &cobra.Command{
1717
Use: "init",
18-
Short: "Initialize rollkit config",
18+
Short: "Initialize evolve config",
1919
Long: fmt.Sprintf("This command initializes a new %s file in the specified directory (or current directory if not specified).", rollconf.ConfigName),
2020
RunE: func(cmd *cobra.Command, args []string) error {
2121
homePath, err := cmd.Flags().GetString(rollconf.FlagRootDir)
@@ -47,7 +47,7 @@ func InitCmd() *cobra.Command {
4747
}
4848

4949
if err := cfg.SaveAsYaml(); err != nil {
50-
return fmt.Errorf("error writing rollkit.yaml file: %w", err)
50+
return fmt.Errorf("error writing evolve.yaml file: %w", err)
5151
}
5252

5353
if err := rollcmd.LoadOrGenNodeKey(homePath); err != nil {
@@ -57,7 +57,7 @@ func InitCmd() *cobra.Command {
5757
// get chain ID or use default
5858
chainID, _ := cmd.Flags().GetString(rollconf.FlagChainID)
5959
if chainID == "" {
60-
chainID = "rollkit-test"
60+
chainID = "evolve-test"
6161
}
6262

6363
// Initialize genesis without app state

0 commit comments

Comments
 (0)