Skip to content

Commit 55bc6c1

Browse files
committed
Split into 3 separate doc sites: /knowledge, /spec, /bluematter
1 parent b84f827 commit 55bc6c1

35 files changed

+164
-82
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Call Flows
24

35
Every function call in the main sync path, traced from CLI entry to disk write.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Codec
24

35
## Overview
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Consensus
24

35
## Overview
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Crypto
24

35
## Overview
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Ledger
24

35
## Overview
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Network
24

35
## Overview
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Node
24

35
## Overview
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Overview
24

35
Bluematter is an independent Cardano full-node implementation in pure Python.

docusaurus.config.ts

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import remarkMath from 'remark-math';
55
import rehypeKatex from 'rehype-katex';
66

77
const config: Config = {
8-
title: 'Bluematter',
8+
title: 'BlueMatter',
99
tagline: 'Cardano Node Implementation',
1010
favicon: 'img/favicon.ico',
1111

@@ -50,23 +50,50 @@ const config: Config = {
5050
'classic',
5151
{
5252
docs: {
53-
sidebarPath: './sidebars.ts',
54-
routeBasePath: '/docs',
53+
id: 'knowledge',
54+
path: 'knowledge-base',
55+
routeBasePath: '/knowledge',
56+
sidebarPath: './sidebarsKnowledge.ts',
5557
remarkPlugins: [remarkMath],
5658
rehypePlugins: [rehypeKatex],
5759
},
60+
blog: false,
5861
pages: {
5962
remarkPlugins: [remarkMath],
6063
rehypePlugins: [rehypeKatex],
6164
},
62-
blog: false,
6365
theme: {
6466
customCss: './src/css/custom.css',
6567
},
6668
} satisfies Preset.Options,
6769
],
6870
],
6971

72+
plugins: [
73+
[
74+
'@docusaurus/plugin-content-docs',
75+
{
76+
id: 'specification',
77+
path: 'specification',
78+
routeBasePath: '/spec',
79+
sidebarPath: './sidebarsSpec.ts',
80+
remarkPlugins: [remarkMath],
81+
rehypePlugins: [rehypeKatex],
82+
},
83+
],
84+
[
85+
'@docusaurus/plugin-content-docs',
86+
{
87+
id: 'bluematter',
88+
path: 'bluematter-arch',
89+
routeBasePath: '/bluematter',
90+
sidebarPath: './sidebarsArch.ts',
91+
remarkPlugins: [remarkMath],
92+
rehypePlugins: [rehypeKatex],
93+
},
94+
],
95+
],
96+
7097
themeConfig: {
7198
colorMode: {
7299
respectPrefersColorScheme: true,
@@ -75,10 +102,19 @@ const config: Config = {
75102
title: 'BlueMatter',
76103
items: [
77104
{
78-
type: 'docSidebar',
79-
sidebarId: 'specSidebar',
105+
to: '/knowledge/intro',
106+
label: 'Knowledge Base',
107+
position: 'left',
108+
},
109+
{
110+
to: '/spec/notation',
111+
label: 'Specification',
112+
position: 'left',
113+
},
114+
{
115+
to: '/bluematter/overview',
116+
label: 'BlueMatter',
80117
position: 'left',
81-
label: 'Docs',
82118
},
83119
{
84120
href: 'https://github.com/Chainscore/bluematter-docs',
@@ -89,7 +125,7 @@ const config: Config = {
89125
},
90126
footer: {
91127
style: 'dark',
92-
copyright: `Bluematter - Independent Cardano Node Implementation`,
128+
copyright: `BlueMatter - Independent Cardano Node Implementation`,
93129
},
94130
prism: {
95131
theme: prismThemes.github,
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
---
2+
---
13
# Current State
24

35
*Last updated: 2026-03-12*

0 commit comments

Comments
 (0)