Skip to content

Commit ec4c866

Browse files
authored
chore: update docs for v1 (1/n) (#564)
* update docs * amend toc * clean up docs * add docs on config * add link to metrci docs * updats to docs * some linting * short description of sequencing
1 parent 828ad26 commit ec4c866

Some content is hidden

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

54 files changed

+1437
-10679
lines changed

.github/workflows/build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ jobs:
1919
- name: Install dependencies
2020
run: yarn install # or pnpm install / npm ci
2121
- name: Build with VitePress
22-
run: yarn docs:build # or pnpm docs:build / npm docs:build
22+
run: yarn build # or pnpm build / npm build

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
- name: Install dependencies
4141
run: yarn install # or pnpm install / npm ci
4242
- name: Build with VitePress
43-
run: yarn docs:build # or pnpm docs:build / npm docs:build
43+
run: yarn build # or pnpm build / npm build
4444
- name: Deploy to GitHub Pages
4545
uses: peaceiris/actions-gh-pages@v4
4646
with:

.github/workflows/preview.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ jobs:
3030
run: yarn install --frozen-lockfile
3131

3232
- name: Build with Base URL
33-
run: BASE='/docs-preview/pr-${{ github.event.number }}/' yarn docs:build
33+
run: BASE='/docs-preview/pr-${{ github.event.number }}/' yarn build
3434

3535
- name: Deploy preview
3636
uses: rossjrw/pr-preview-action@v1

.vitepress/config.ts

Lines changed: 27 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,6 @@ function nav() {
174174
{ text: "Learn", link: "/learn/intro" },
175175
{ text: "Tutorials", link: "/tutorials/quick-start" },
176176
{ text: "How To Guides", link: "/guides/overview" },
177-
// { text: "Testnets", link: "/testnets/cosmwasm-testnet" },
178177
{ text: "Blog", link: "/blog/overview" },
179178
];
180179
}
@@ -218,7 +217,7 @@ function sidebarHome() {
218217
text: "Quick start guide",
219218
link: "/tutorials/quick-start",
220219
},
221-
{ text: "Build a chain", link: "/tutorials/wordle" },
220+
{ text: "Build a chain", link: "/tutorials/gm-world" },
222221
{
223222
text: "DA",
224223
collapsed: true,
@@ -235,10 +234,6 @@ function sidebarHome() {
235234
text: "Celestia",
236235
link: "/tutorials/da/celestia-da",
237236
},
238-
{
239-
text: "Avail",
240-
link: "/tutorials/da/avail-da",
241-
},
242237
],
243238
},
244239
{
@@ -250,12 +245,8 @@ function sidebarHome() {
250245
link: "/tutorials/sequencing/overview",
251246
},
252247
{
253-
text: "Local",
254-
link: "/tutorials/sequencing/local",
255-
},
256-
{
257-
text: "Centralized",
258-
link: "/tutorials/sequencing/centralized",
248+
text: "Single",
249+
link: "/tutorials/sequencing/single",
259250
},
260251
{
261252
text: "Based",
@@ -265,32 +256,20 @@ function sidebarHome() {
265256
text: "Forced Inclusion",
266257
link: "/tutorials/sequencing/forced-inclusion",
267258
},
268-
{
269-
text: "Astria",
270-
link: "/tutorials/sequencing/astria",
271-
},
272259
],
273260
},
274261
{
275262
text: "Execution",
276263
collapsed: true,
277264
items: [
278265
{ text: "CosmWasm", link: "/tutorials/execution/cosmwasm" },
279-
{
280-
text: "EVM",
281-
collapsed: true,
282-
items: [
283-
{ text: "BeaconKit EVM", link: "/tutorials/execution/beaconkit" },
284-
{
285-
text: "Artela EVM++",
286-
link: "/tutorials/execution/artela-evm-plus-plus",
287-
},
288-
{
289-
text: "Contract interaction",
290-
link: "/tutorials/execution/evm-contract-interaction",
291-
},
292-
],
293-
},
266+
// {
267+
// text: "EVM",
268+
// collapsed: true,
269+
// items: [
270+
// // { text: "RETH EVM", link: "/tutorials/execution/reth-evm" },
271+
// ],
272+
// },
294273
],
295274
},
296275
{
@@ -305,10 +284,6 @@ function sidebarHome() {
305284
text: "Docker Compose",
306285
link: "/tutorials/docker-compose",
307286
},
308-
// {
309-
// text: "Kurtosis",
310-
// link: "/tutorials/kurtosis",
311-
// },
312287
],
313288
},
314289
],
@@ -317,14 +292,14 @@ function sidebarHome() {
317292
text: "How To Guides",
318293
collapsed: true,
319294
items: [
320-
{
321-
text: "Use the Rollkit CLI",
322-
link: "/guides/use-rollkit-cli",
323-
},
324295
{
325296
text: "Use Ignite to create a Rollkit app",
326297
link: "/guides/ignite-rollkit",
327298
},
299+
{
300+
text: "Run a Full Node",
301+
link: "/guides/full-node",
302+
},
328303
{
329304
text: "Restart your rollup",
330305
link: "/guides/restart-rollup",
@@ -333,10 +308,6 @@ function sidebarHome() {
333308
text: "Reset your chain's state",
334309
link: "/guides/reset-state",
335310
},
336-
{
337-
text: "Run a rollup full node",
338-
link: "/guides/full-node",
339-
},
340311
{
341312
text: "CometBFT into a Rollkit app",
342313
link: "/guides/cometbft-to-rollkit",
@@ -347,33 +318,19 @@ function sidebarHome() {
347318
},
348319
{
349320
text: "Configuration",
350-
collapsed: true,
351-
items: [
352-
{
353-
text: "Configure gas price",
354-
link: "/guides/gas-price",
355-
},
356-
{
357-
text: "Configure max pending blocks",
358-
link: "/guides/max-pending-blocks",
359-
},
360-
{
361-
text: "Configure DA chain block sync time",
362-
link: "/guides/da-block-time",
363-
},
364-
{
365-
text: "Change speed of block production",
366-
link: "/guides/block-times",
367-
},
368-
{
369-
text: "Use lazy sequencing (aggregation)",
370-
link: "/guides/lazy-sequencing",
371-
},
372-
{
373-
text: "Configure Prometheus metrics",
374-
link: "/guides/metrics",
375-
},
376-
],
321+
link: "/guides/config",
322+
},
323+
{
324+
text: "EVM Single Sequencer",
325+
link: "/guides/evm-single",
326+
},
327+
{
328+
text: "EVM Based Sequencer",
329+
link: "/guides/evm-based",
330+
},
331+
{
332+
text: "Metrics",
333+
link: "/guides/metrics",
377334
},
378335
{
379336
text: "Integrations",
@@ -388,10 +345,6 @@ function sidebarHome() {
388345
text: "Add an IBC connection to your rollup",
389346
link: "/guides/ibc-connection",
390347
},
391-
{
392-
text: "Integrate Range with your rollup",
393-
link: "/guides/rollkit-monitoring",
394-
},
395348
{
396349
text: "Use IBC token (TIA) as gas token in your rollup",
397350
link: "/guides/use-tia-for-gas",
@@ -400,11 +353,6 @@ function sidebarHome() {
400353
},
401354
],
402355
},
403-
// {
404-
// text: "Testnets",
405-
// collapsed: true,
406-
// items: [{ text: "CosmWasm Testnet", link: "/testnets/cosmwasm-testnet" }],
407-
// },
408356
{
409357
text: "Blog",
410358
collapsed: true,

guides/block-times.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

0 commit comments

Comments
 (0)