Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/more #38

Merged
merged 2 commits into from
Oct 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pages/_meta.en.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@
"overview": {
"title": "Overview"
},
"architecture": {
"title": "Architecture"
},
"start": {
"title": "Start a self-hosted chain"
},
"chain-architecture": {
"title": "Architecture"
},
"chain-configuration": {
"title": "Configuration"
},
Expand All @@ -63,7 +63,7 @@
"type": "separator"
},
"--- Tutorials": {
"title": "Tutorials",
"title": "TUTORIALS",
"type": "separator"
},
"tutorials-full-node": {
Expand Down
7 changes: 7 additions & 0 deletions pages/chain-architecture/_meta.en.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"architecture": "Architecture",
"sequencer": "Sequencer",
"bootstrapper": "Bootstrapper",
"orchestrator": "Orchestrator",
"snos": "SNOS"
}
22 changes: 22 additions & 0 deletions pages/chain-architecture/architecture.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Architecture
lang: en-US
description: A guide to monitor your node using Architecture.
---

import { Steps } from "nextra-theme-docs";

Check warning on line 7 in pages/chain-architecture/architecture.mdx

View workflow job for this annotation

GitHub Actions / Run vale / runner / vale

[vale] reported by reviewdog 🐶 [madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words). Raw Output: {"message": "[madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words).", "location": {"path": "pages/chain-architecture/architecture.mdx", "range": {"start": {"line": 7, "column": 1}}}, "severity": "INFO"}
import { Callout } from "nextra-theme-docs";
import { Cards, Card } from "nextra/components";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import {
faLinux,
faApple,
faWindows,
} from "@fortawesome/free-brands-svg-icons";
import { Tabs, Tab } from "nextra/components";

# 🚧 Architecture

<Callout type="warning" emoji="⚠️">
This section is still under construction.
</Callout>
22 changes: 22 additions & 0 deletions pages/chain-architecture/bootstrapper.en.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Bootstrapper
lang: en-US
description: A guide to monitor your node using Bootstrapper.
---

import { Steps } from "nextra-theme-docs";

Check warning on line 7 in pages/chain-architecture/bootstrapper.en.mdx

View workflow job for this annotation

GitHub Actions / Run vale / runner / vale

[vale] reported by reviewdog 🐶 [madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words). Raw Output: {"message": "[madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words).", "location": {"path": "pages/chain-architecture/bootstrapper.en.mdx", "range": {"start": {"line": 7, "column": 1}}}, "severity": "INFO"}
import { Callout } from "nextra-theme-docs";
import { Cards, Card } from "nextra/components";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import {
faLinux,
faApple,
faWindows,
} from "@fortawesome/free-brands-svg-icons";
import { Tabs, Tab } from "nextra/components";

# 🚧 Bootstrapper

<Callout type="warning" emoji="⚠️">
This section is still under construction.
</Callout>
22 changes: 22 additions & 0 deletions pages/chain-architecture/orchestrator.en.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Orchestrator
lang: en-US
description: A guide to monitor your node using Orchestrator.
---

import { Steps } from "nextra-theme-docs";

Check warning on line 7 in pages/chain-architecture/orchestrator.en.mdx

View workflow job for this annotation

GitHub Actions / Run vale / runner / vale

[vale] reported by reviewdog 🐶 [madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words). Raw Output: {"message": "[madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words).", "location": {"path": "pages/chain-architecture/orchestrator.en.mdx", "range": {"start": {"line": 7, "column": 1}}}, "severity": "INFO"}
import { Callout } from "nextra-theme-docs";
import { Cards, Card } from "nextra/components";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import {
faLinux,
faApple,
faWindows,
} from "@fortawesome/free-brands-svg-icons";
import { Tabs, Tab } from "nextra/components";

# 🚧 Orchestrator

<Callout type="warning" emoji="⚠️">
This section is still under construction.
</Callout>
22 changes: 22 additions & 0 deletions pages/chain-architecture/sequencer.en.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Sequencer
lang: en-US
description: A guide to monitor your node using Sequencer.
---

import { Steps } from "nextra-theme-docs";

Check warning on line 7 in pages/chain-architecture/sequencer.en.mdx

View workflow job for this annotation

GitHub Actions / Run vale / runner / vale

[vale] reported by reviewdog 🐶 [madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words). Raw Output: {"message": "[madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words).", "location": {"path": "pages/chain-architecture/sequencer.en.mdx", "range": {"start": {"line": 7, "column": 1}}}, "severity": "INFO"}
import { Callout } from "nextra-theme-docs";
import { Cards, Card } from "nextra/components";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import {
faLinux,
faApple,
faWindows,
} from "@fortawesome/free-brands-svg-icons";
import { Tabs, Tab } from "nextra/components";

# 🚧 Sequencer

<Callout type="warning" emoji="⚠️">
This section is still under construction.
</Callout>
22 changes: 22 additions & 0 deletions pages/chain-architecture/snos.en.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: SNOS
lang: en-US
description: A guide to monitor your node using SNOS.
---

import { Steps } from "nextra-theme-docs";

Check warning on line 7 in pages/chain-architecture/snos.en.mdx

View workflow job for this annotation

GitHub Actions / Run vale / runner / vale

[vale] reported by reviewdog 🐶 [madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words). Raw Output: {"message": "[madara-docs.SentenceLength] Try to keep sentences short ( less than 25 words).", "location": {"path": "pages/chain-architecture/snos.en.mdx", "range": {"start": {"line": 7, "column": 1}}}, "severity": "INFO"}
import { Callout } from "nextra-theme-docs";
import { Cards, Card } from "nextra/components";
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
import {
faLinux,
faApple,
faWindows,
} from "@fortawesome/free-brands-svg-icons";
import { Tabs, Tab } from "nextra/components";

# 🚧 SNOS

<Callout type="warning" emoji="⚠️">
This section is still under construction.
</Callout>
44 changes: 22 additions & 22 deletions pages/overview.en.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,58 +9,53 @@ import {
Server,
Settings,
Network,
Plug,
Play,
Wrench,
Blocks,
Rocket,
MonitorCog,
PencilRuler,
HardDrive,
FlaskConical,
Globe,
Activity,
Sprout,
BrainCircuit,
} from "lucide-react";
import { Callout } from "nextra-theme-docs";

# Chain Operators

Welcome to the Chain Operators section of the Madara documentation, your comprehensive resource for running and customizing your Madara App Chain.

Here, we will help you install and configure your Madara client to best meet your needs. We wanted to make this documentation accessible to everyone, so we divided it into several levels ranging from low to high, and covers different ways of launching your Madara client: **Sequencer**, **Full Node**, and **devnet**.
Welcome to the Chain Operators section of the Madara documentation, your comprehensive resource for running your Madara App Chain. Here, we will help you configure and customize your own App Chain to best meet your needs.

<Callout type="info" emoji="ℹ️">
This section is intended to configure your node to participate in or launch
your own network. To configure your own App Chain, you should head up to the
[Chain Operator](/overview) section.
This section is intended to help you configure and customize your Chain. To
configure Madara as a client, you should head up to the [Chain
Operator](/overview) section.
</Callout>

## Starting Points for Node Operators
## Starting Points for Chain Operators

From setting up a Full Node to configuring a Sequencer or your own Devnet, all the guides and resources you need are here.
From launching a self-hosted Madara App Chain to configuring an entire Network, here are all the ressources you need to get started

<Cards>
<Card
title="System requirements"
title="Architecture"
href="/get-started/requirements"
icon={<MonitorCog size={24} color="#ff000d" />}
icon={<PencilRuler size={24} color="#ff000d" />}
/>
<Card
title="Installation Guides"
title="Launch your chain"
href="/get-started/install"
icon={<Plug size={24} color="#ff000d" />}
icon={<Play size={24} color="#ff000d" />}
/>
<Card
title="Configuration"
href="/fundamentals/configuration"
icon={<Settings size={24} color="#ff000d" />}
/>
<Card
title="Interact with Madara"
title="Management"
href="/interacting/methods"
icon={<Globe size={24} color="#ff000d" />}
/>
<Card
title="Monitor"
href="/monitoring/grafana"
icon={<Activity size={24} color="#ff000d" />}
icon={<Blocks size={24} color="#ff000d" />}
/>
</Cards>

Expand All @@ -79,6 +74,11 @@ Take advantage of these essential tools to start and optimize your Madara node.
href="https://github.com/madara-alliance/madara-bootstrapper"
icon={<Rocket size={24} color="#ff000d" />}
/>
<Card
title="Snos"
href="https://github.com/keep-starknet-strange/snos"
icon={<BrainCircuit size={24} color="#ff000d" />}
/>
</Cards>

## Learn More
Expand Down
Loading