Skip to content

Commit b84f827

Browse files
committed
Split sidebar: Knowledge Base / Specification / BlueMatter. Clean titles, remove AI words, fix anchors
1 parent e2199fe commit b84f827

19 files changed

+38
-37
lines changed

docs/architecture/call-flows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ while blocks_synced < max_blocks: # sync_session.py:243
294294
│ └─────────────────────────────────────────────────────┘
295295
```
296296

297-
## 6. apply_block() - Detailed Internal Flow
297+
## 6. apply_block() - Internal Flow
298298

299299
```
300300
apply_block(state, block) # block.py:25

docs/architecture/consensus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Block header validation for Ouroboros Praos. Contains the central `validate_head
4141

4242
**Key functions:**
4343

44-
- `validate_header(header, prev_hash, prev_slot, prev_block_number, ...) -> list[str]` -- Full header validation (see detailed breakdown below).
44+
- `validate_header(header, prev_hash, prev_slot, prev_block_number, ...) -> list[str]` -- Header validation (see breakdown below).
4545
- `_verify_operational_cert(opcert, issuer_vkey) -> list[str]` -- Verifies the Ed25519 cold-key signature over `hot_vkey || seq_no(8 bytes BE) || kes_period(8 bytes BE)`.
4646
- `compute_pool_id(issuer_vkey: bytes) -> bytes` -- Returns `blake2b_224(issuer_vkey)`.
4747
- `verify_block_hash(header: ConwayHeader) -> bool` -- Checks `header.block_hash == blake2b_256(header.raw)`.

docs/architecture/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ bluematter/
2424
config/ Genesis file parsing
2525
```
2626

27-
## Detailed Documentation
27+
## Documentation
2828

2929
| Document | Covers |
3030
|----------|--------|

docs/cardano/current-state.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
*Last updated: 2026-03-12*
44

5-
This document provides a comprehensive overview of the Cardano ecosystem as of March 2026,
5+
This document provides a overview of the Cardano ecosystem as of March 2026,
66
covering the current network state, governance, consensus research, scaling solutions,
77
alternative node implementations, and the forward-looking roadmap.
88

@@ -209,7 +209,7 @@ achieves higher throughput but requires 2-3 minute confirmations and extensive e
209209
|---|---|
210210
| Research paper published | COMPLETE |
211211
| CIP specification | ~67% complete (Jan 2026) |
212-
| Detailed specifications | IN PROGRESS |
212+
| Specifications | IN PROGRESS |
213213
| Simulations | IN PROGRESS |
214214
| Code implementation | IN PROGRESS |
215215
| Testnet deployment | PLANNED (2026) |
@@ -311,7 +311,7 @@ the original Haskell implementation through its development process.
311311
- Connects via Ouroboros N2N mini-protocols (via Pallas library)
312312

313313
**Recent releases**:
314-
- v1.0.0-rc.10 (Feb 17, 2026): Comprehensive mempool support, OTLP integration
314+
- v1.0.0-rc.10 (Feb 17, 2026): Mempool support, OTLP integration
315315
- v1.0.0-rc.8 (Feb 7, 2026): Byron address parsing, memory caches, mainnet genesis support
316316

317317
### Pallas (Rust Library) -- TxPipe

docs/cardano/eras.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Era Evolution
1+
# Eras
22

3-
> Comprehensive reference for all Cardano eras, hard forks, protocol versions, and
3+
> Reference for all Cardano eras, hard forks, protocol versions, and
44
> ledger rule changes. Accurate as of March 2026.
55
66
---

docs/cardano/ledger-specs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Formal Ledger Specs
1+
# Ledger Specs
22

3-
This document is a comprehensive reference for the Cardano formal ledger specifications, extracted from the official `.tex` source files in the `cardano-ledger` repository, supplemented with web research on the Conway era. It covers all eras from Shelley through Conway.
3+
This document is a reference for the Cardano formal ledger specifications, based on the official `.tex` source files in the `cardano-ledger` repository, supplemented with web research on the Conway era. It covers all eras from Shelley through Conway.
44

55
---
66

docs/cardano/networking.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Networking Protocols
1+
# Networking
22

3-
Comprehensive reference for the Ouroboros network layer used in Cardano.
3+
Reference for the Ouroboros network layer used in Cardano.
44
Based on the [Ouroboros Network Specification](https://ouroboros-network.cardano.intersectmbo.org/pdfs/network-spec/network-spec.pdf),
55
the [Cardano Blueprint](https://cardano-scaling.github.io/cardano-blueprint/network/index.html),
66
and the [ouroboros-network repository](https://github.com/IntersectMBO/ouroboros-network).

docs/cardano/node-architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Haskell Node Architecture
1+
# Node Architecture
22

3-
This document provides a detailed technical reference of the Cardano Haskell node
3+
This document is a technical reference of the Cardano Haskell node
44
(`cardano-node`) architecture, intended for implementers building alternative node
55
implementations. It covers the four major layers (consensus, ledger, networking,
66
storage), how they interact, and the node orchestration that ties them together.

docs/cardano/research.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Research & Foundations
1+
# Research
22

3-
A comprehensive reference covering the academic research that underpins the Cardano
3+
Reference covering the academic research that underpins the Cardano
44
blockchain, from the founding vision through the Ouroboros consensus protocol family,
55
the Extended UTXO model, formal ledger specifications, and scaling research.
66

@@ -323,7 +323,7 @@ transactions.
323323
- **Key-private forward-secure encryption**: Ensures privacy is maintained even
324324
against adaptive attacks over time.
325325

326-
- **GUC treatment of private ledgers**: A thorough formalization of private ledger
326+
- **GUC treatment of private ledgers**: A formalization of private ledger
327327
security in the Generalized Universal Composability setting.
328328

329329
**Relation to the running network**: Crypsinous is not deployed on Cardano mainnet but
@@ -454,7 +454,7 @@ Peras, Leios, and other innovations into a single adaptive system.
454454
- **Dynamic performance adaptation**: Throughput and settlement automatically adjust
455455
to network conditions.
456456

457-
- **Comprehensive proof**: Aims to either find practical solutions or rigorously prove
457+
- **Proof**: Aims to either find practical solutions or rigorously prove
458458
what is and is not possible without sacrificing security.
459459

460460
Combining Leios with the EUTXO model could theoretically support throughput of up to
@@ -576,7 +576,7 @@ incentivized participation.
576576

577577
### Reward Sharing Schemes (Shelley Design Specification)
578578

579-
The reward-sharing scheme, detailed in the **Shelley Delegation and Incentives Design
579+
The reward-sharing scheme, described in the **Shelley Delegation and Incentives Design
580580
Specification (SL-D5)**, describes how to properly incentivize stake pool operators
581581
and delegators. Key properties:
582582

docs/intro.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This book is the complete technical reference: protocol theory, formal specifica
2727

2828
## What This Book Covers
2929

30-
### Part I - Cardano Protocol (Chapters 1–6)
30+
### Knowledge Base
3131

3232
The theoretical and historical foundation. Start here if you're new to Cardano.
3333

@@ -40,7 +40,7 @@ The theoretical and historical foundation. Start here if you're new to Cardano.
4040
| **5. Networking Protocols** | Mini-protocol state machines, multiplexer wire format, CDDL message definitions |
4141
| **6. Current State & Roadmap** | Where Cardano is today (2026): governance, Genesis, Leios, UTxO-HD, alternative nodes |
4242

43-
### Part II - Formal Specification (Chapters 7–20)
43+
### Specification
4444

4545
The Gray Paper. Precise equations defining every data type, validation rule, and state transition. **Someone could reimplement the entire node from Part II alone.**
4646

@@ -61,7 +61,7 @@ The Gray Paper. Precise equations defining every data type, validation rule, and
6161
| **19. Networking** | Multiplexer framing, 5 mini-protocol state machines, peer selection governor |
6262
| **20. Storage** | VolatileDB (fork-aware), ImmutableDB (SQLite), LedgerDB (HMAC checkpoints), crash recovery |
6363

64-
### Part III - Bluematter Architecture (Chapters 21–28)
64+
### BlueMatter
6565

6666
How the Python implementation maps to the spec. The **Call Flows** chapter is the most important - it traces every function call from CLI entry through TCP handshake, block decode, validation, ledger update, all the way to disk write.
6767

@@ -128,7 +128,7 @@ How the Python implementation maps to the spec. The **Call Flows** chapter is th
128128

129129
## Quick Links
130130

131-
- [Call Flows - the most detailed chapter](./architecture/call-flows.md) - every function call traced
131+
- [Call Flows - the key chapter](./architecture/call-flows.md) - every function call traced
132132
- [Transaction Validation Rules](./spec/transactions.md) - all 19 UTxO predicates
133133
- [Reward Calculation Formula](./spec/rewards.md) - the complete Shelley incentive math
134134
- [Nonce Evolution Lifecycle](./spec/consensus.md) - UPDN + TICKN rules

0 commit comments

Comments
 (0)