logos-blockchain/logos-blockchain-testing
1
0
Fork 0
mirror of https://github.com/logos-blockchain/logos-blockchain-testing.git synced 2026-01-02 13:23:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(gitbook): include unlinked pages and fix examples path

Browse Source
This commit is contained in:
andrussal 2025-12-16 06:22:39 +01:00
parent 6031e7fd98
commit 0210e857f0
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
book/src/SUMMARY.md
View File

@ -1,6 +1,7 @@
# Summary
- [Project Context Primer](project-context-primer.md)
- [What You Will Learn](what-you-will-learn.md)
- [Quickstart](quickstart.md)
- [Part I — Foundations](part-i.md)
- [Introduction](introduction.md)
- [Architecture Overview](architecture-overview.md)
@ -14,10 +15,14 @@
- [Core Content: Workloads & Expectations](workloads.md)
- [Core Content: ScenarioBuilderExt Patterns](scenario-builder-ext-patterns.md)
- [Best Practices](best-practices.md)
- [Usage Patterns](usage-patterns.md)
- [Examples](examples.md)
- [Advanced & Artificial Examples](examples-advanced.md)
- [Running Scenarios](running-scenarios.md)
- [Runners](runners.md)
- [Node Control & RunContext](node-control.md)
- [Chaos Workloads](chaos.md)
- [Topology & Chaos Patterns](topology-chaos.md)
- [Operations](operations.md)
- [Part III — Developer Reference](part-iii.md)
- [Scenario Model (Developer Level)](scenario-model.md)

2
book/src/internal-crate-reference.md
View File

@ -10,7 +10,7 @@ High-level roles of the crates that make up the framework:
- **Runners** (`testing-framework/runners/{local,compose,k8s}/`): Implements deployment backends (local host, Docker Compose, Kubernetes) that all consume the same scenario plan. Each provides a `Deployer` implementation (`LocalDeployer`, `ComposeDeployer`, `K8sDeployer`).
- **Runner Examples** (`examples/runner-examples`): Runnable binaries demonstrating framework usage and serving as living documentation. These are the **primary entry point** for running scenarios (`local_runner.rs`, `compose_runner.rs`, `k8s_runner.rs`).
- **Runner Examples** (crate name: `runner-examples`, path: `examples/`): Runnable binaries demonstrating framework usage and serving as living documentation. These are the **primary entry point** for running scenarios (`examples/src/bin/local_runner.rs`, `examples/src/bin/compose_runner.rs`, `examples/src/bin/k8s_runner.rs`).
## Where to Add New Capabilities

7
book/src/workspace-layout.md
View File

@ -12,9 +12,10 @@ repeatable and portable:
and reusable expectations assembled into a user-facing DSL.
- **Runners**: deployment backends for local processes, Docker Compose, and
Kubernetes, all consuming the same scenario plan.
- **Runner Examples** (`examples/runner-examples`): runnable binaries
(`local_runner.rs`, `compose_runner.rs`, `k8s_runner.rs`) that demonstrate
complete scenario execution with each deployer.
- **Runner Examples** (crate name: `runner-examples`, path: `examples/`):
runnable binaries (`examples/src/bin/local_runner.rs`,
`examples/src/bin/compose_runner.rs`, `examples/src/bin/k8s_runner.rs`) that
demonstrate complete scenario execution with each deployer.
This split keeps configuration, orchestration, reusable traffic patterns, and
deployment adapters loosely coupled while sharing one mental model for tests.