prettier

.github/workflows/linters.yml

@@ -0,0 +1,15 @@
+---
+name: Task - Linters
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Run prettier
+        run: |-
+          npx prettier --check .

.github/workflows/pull-request.yml

@@ -0,0 +1,22 @@
+---
+name: Workflow - Pull Request
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  linters:
+    name: Run linters
+    uses: ./.github/workflows/linters.yml
+
+  vale:
+    name: Run vale
+    uses: ./.github/workflows/vale.yml
+
+  spellcheck:
+    name: Run spellcheck
+    uses: ./.github/workflows/spellcheck.yml

.github/workflows/spellcheck.yml

@@ -0,0 +1,16 @@
+---
+name: Spell Check
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install cspell
+        run: npm install -g cspell
+      - name: Run spell check
+        run: cspell "**/*.mdx"

.github/workflows/vale.yml

@@ -0,0 +1,14 @@
+---
+name: reviewdog
+
+on:
+  workflow_dispatch:
+  workflow_call:
+
+jobs:
+  vale:
+    name: runner / vale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: errata-ai/vale-action@reviewdog

.vale.ini

@@ -0,0 +1,19 @@
+StylesPath = vale/writing-styles
+MinAlertLevel = suggestion
+
+[formats]
+mdx = md
+
+# Ignore code on basis of certain HTML tags.
+IgnoredClasses= whitesapce-pre, prose-code
+SkippedScopes = script, style, pre, figure, code, tt, tr, td, span
+
+# Settings applied to md/mdx format.
+[*.md]
+
+# List of styles to load
+BasedOnStyles = madara-docs
+
+# Ignore code surrounded by backticks or plus sign, parameters defaults, URLs and so on.
+BlockIgnores = (?s) <Terminal(\s|\n)[^/>]*?property
+TokenIgnores = (\x60[^\n\x60]+\x60), ([^\n]+=[^\n]*), (\+[^\n]+\+), (http[^\n]+\[), .github, .gitlab, vscode-, Signing & Capabilities, eas.json, eas-json, .yarn+, yarn: "# yarn", eas+, eas-cli, npx+, Build & deploy, OAuth & Permissions, Languages & Frameworks, typescript, Privacy & Security, Certificates, IDs & Profiles, application/javascript, Motion & Orientation Access, Show devices and ask me again, my-app,  Still having trouble?, "my app runs well locally by crashes immediately when I run a build", my-app, MY_CUSTOM_API_KEY, withMyApiKey, My App, com.my., myFunction, my app, my-plugin, my-module, 'Hello from my TypeScript function!', my-scheme, my-root, Change my environment variables, my custom plugin, my, cocoapods, javascript, Ink & Switch,

components/LightorDarkImage.tsx

@@ -1,19 +1,18 @@
-import Image from 'next/image'
-import { useTheme } from 'next-themes'
+import Image from "next/image";
+import { useTheme } from "next-themes";
 
-const LightorDarkImage = ({ lightModeSrc, darkModeSrc, alt, width = 800, height = 600 }) => {
-  const { theme } = useTheme()
+const LightorDarkImage = ({
+  lightModeSrc,
+  darkModeSrc,
+  alt,
+  width = 800,
+  height = 600,
+}) => {
+  const { theme } = useTheme();
 
-  const imageSrc = theme === 'dark' ? darkModeSrc : lightModeSrc
+  const imageSrc = theme === "dark" ? darkModeSrc : lightModeSrc;
 
-  return (
-    <Image
-      src={imageSrc}
-      alt={alt}
-      width={width}
-      height={height}
-    />
-  )
-}
+  return <Image src={imageSrc} alt={alt} width={width} height={height} />;
+};
 
-export default LightorDarkImage
+export default LightorDarkImage;

cspell.json

@@ -0,0 +1,20 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "words": [],
+  "flagWords": [],
+  "ignorePaths": [],
+  "dictionaryDefinitions": [
+    {
+      "name": "starknet",
+      "path": "./dictionary/starknet.txt",
+      "addWords": true
+    },
+    {
+      "name": "technical",
+      "path": "./dictionary/technical.txt",
+      "addWords": true
+    }
+  ],
+  "dictionaries": ["starknet", "technical"]
+}

dictionary/starknet.txt

@@ -0,0 +1,15 @@
+starknet
+madara
+scarb
+keccak
+devnet
+pedersen
+deoxys
+starkware
+chainstack
+appchains
+snos
+bootstrapper
+kakarot
+merkle
+starknodes

dictionary/technical.txt

@@ -0,0 +1,10 @@
+nextra
+rustc
+moralis
+pkill
+predeployed
+nextra
+lsync
+SLES
+sonoma
+rustup

middleware.js

@@ -1 +1 @@
-export { locales as middleware } from 'nextra/locales'
+export { locales as middleware } from "nextra/locales";

next.config.js

@@ -1,11 +1,11 @@
-const withNextra = require('nextra')({
-  theme: 'nextra-theme-docs',
-  themeConfig: './theme.config.tsx',
-})
+const withNextra = require("nextra")({
+  theme: "nextra-theme-docs",
+  themeConfig: "./theme.config.tsx",
+});
 
 module.exports = withNextra({
-i18n: {
-  locales: ['en', 'zh-CN'],
-  defaultLocale: 'en'
-}
-})
+  i18n: {
+    locales: ["en", "zh-CN"],
+    defaultLocale: "en",
+  },
+});

pages/_meta.en.json

@@ -78,7 +78,7 @@
   "tutorials-devnet": {
     "title": "Devnet"
   },
-  
+
   "+++ ABOUT": {
     "title": "",
     "type": "separator"

pages/chain-architecture/architecture.mdx

@@ -19,4 +19,4 @@ import { Tabs, Tab } from "nextra/components";
 
 <Callout type="warning" emoji="⚠️">
   This section is still under construction.
-</Callout>
+</Callout>

pages/chain-architecture/bootstrapper.en.mdx

@@ -19,4 +19,4 @@ import { Tabs, Tab } from "nextra/components";
 
 <Callout type="warning" emoji="⚠️">
   This section is still under construction.
-</Callout>
+</Callout>

pages/chain-architecture/orchestrator.en.mdx

@@ -19,4 +19,4 @@ import { Tabs, Tab } from "nextra/components";
 
 <Callout type="warning" emoji="⚠️">
   This section is still under construction.
-</Callout>
+</Callout>

pages/chain-architecture/sequencer.en.mdx

@@ -19,4 +19,4 @@ import { Tabs, Tab } from "nextra/components";
 
 <Callout type="warning" emoji="⚠️">
   This section is still under construction.
-</Callout>
+</Callout>

pages/chain-architecture/snos.en.mdx

@@ -19,4 +19,4 @@ import { Tabs, Tab } from "nextra/components";
 
 <Callout type="warning" emoji="⚠️">
   This section is still under construction.
-</Callout>
+</Callout>

pages/chain-configuration/overview.en.mdx

@@ -4,9 +4,20 @@ lang: en-US
 description: Learn how to install and configure your Madara client as a node operator.
 ---
 
-import { Cards, Card } from 'nextra/components'
-import { Server, Settings, Network, Plug, Wrench, Rocket, MonitorCog, HardDrive, FlaskConical, Globe, Activity } from 'lucide-react';
+import { Cards, Card } from "nextra/components";
+import {
+  Server,
+  Settings,
+  Network,
+  Plug,
+  Wrench,
+  Rocket,
+  MonitorCog,
+  HardDrive,
+  FlaskConical,
+  Globe,
+  Activity,
+} from "lucide-react";
 import { Callout } from "nextra-theme-docs";
 
 # Chain Operator Configurations
-