Skip to content

Commit 4decfe3

Browse files
authored
Merge pull request #1476 from o1-labs/dw/split-o1labs-infrastructure-frontend-section
Website: improve documentation by adding sections for infra and linking tracking issues
2 parents a084159 + 366c26b commit 4decfe3

File tree

6 files changed

+60
-19
lines changed

6 files changed

+60
-19
lines changed

website/docs/node-operators/archive-node.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,10 +81,13 @@ Ensure Docker and Docker Compose are installed on your system -
8181
8282
<!-- prettier-ignore-start -->
8383
84-
:::warning Required Configuration The archive node requires a `.env` file
85-
with PostgreSQL database settings. The example above provides the minimum
86-
required configuration. You can customize the database password and other
87-
settings as needed. :::
84+
:::warning Required Configuration
85+
86+
The archive node requires a `.env` file with PostgreSQL database settings.
87+
The example above provides the minimum required configuration. You can
88+
customize the database password and other settings as needed.
89+
90+
:::
8891
8992
<!-- prettier-ignore-stop -->
9093
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Block Producers
3+
description: o1Labs block producer infrastructure on dev-net
4+
sidebar_position: 5
5+
---
6+
7+
# Block Producers
8+
9+
This section is still a work in progress. It will cover the block producers that
10+
the o1Labs team runs on dev-net.
11+
12+
Track progress: [Issue #1463](https://github.com/o1-labs/mina-rust/issues/1463)

website/docs/node-operators/infrastructure/frontend.mdx

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,21 @@ sidebar_position: 4
66

77
# Frontend
88

9-
<!-- prettier-ignore-start -->
9+
The o1Labs frontend infrastructure provides web-based interfaces for interacting
10+
with the Mina network. This infrastructure is divided into two main components.
1011

11-
:::caution Under Construction
12+
## Node Dashboard
1213

13-
This page is currently under construction. o1Labs frontend infrastructure
14-
documentation will be added here once the production frontend is deployed and
15-
available.
14+
This section is still a work in progress. For information about the Node
15+
Dashboard, refer to the developers documentation of the
16+
[node dashboard](../../developers/frontend/node-dashboard.mdx).
1617

17-
The frontend will provide:
18+
Track progress: [Issue #1461](https://github.com/o1-labs/mina-rust/issues/1461)
1819

19-
- Web-based network monitoring
20-
- Real-time blockchain statistics
21-
- Node management interface
22-
- Network visualization tools
20+
## WebNode
2321

24-
Check back soon for complete documentation on accessing the o1Labs frontend
25-
infrastructure.
22+
This section is still a work in progress. For information about the WebNode,
23+
refer to the developers documentation of the
24+
[web node](../../developers/frontend/webnode.mdx).
2625

27-
:::
28-
29-
<!-- prettier-ignore-stop -->
26+
Track progress: [Issue #1474](https://github.com/o1-labs/mina-rust/issues/1474)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Memory Profiler
3+
description: o1Labs nodes with memory profiler for performance monitoring
4+
sidebar_position: 6
5+
---
6+
7+
# Memory Profiler
8+
9+
This section is still a work in progress. It will cover nodes running with a
10+
memory profiler for performance analysis and optimization. The memory profiler
11+
data is used by the node dashboard for debugging purposes.
12+
13+
Track progress: [Issue #1207](https://github.com/o1-labs/mina-rust/issues/1207)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
title: Network Debugger
3+
description: o1Labs nodes with network debugger for troubleshooting
4+
sidebar_position: 7
5+
---
6+
7+
# Network Debugger
8+
9+
This section is still a work in progress. It will cover nodes running with the
10+
network debugger for network analysis and troubleshooting. The network debugger
11+
data is used by the node dashboard for debugging purposes.
12+
13+
Track progress: [Issue #1365](https://github.com/o1-labs/mina-rust/issues/1365)

website/sidebars.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ const sidebars: SidebarsConfig = {
4747
'node-operators/infrastructure/seed-nodes',
4848
'node-operators/infrastructure/plain-nodes',
4949
'node-operators/infrastructure/archive-nodes',
50+
'node-operators/infrastructure/block-producers',
51+
'node-operators/infrastructure/memory-profiler',
52+
'node-operators/infrastructure/network-debugger',
5053
'node-operators/infrastructure/frontend',
5154
],
5255
},

0 commit comments

Comments
 (0)