Skip to content

Commit f8018df

Browse files
committed
Restructure intro to defer engine list
Open 101_introduction.md with a higher-level framing (deterministic routing system, stable abstraction above the concrete algorithm, host-composable engines) and move the seven-engine list plus the published-shape distinction into a new In-Tree Engines section placed after System Shape. Link Crate Architecture in the docs-layout paragraph.
1 parent e656d67 commit f8018df

1 file changed

Lines changed: 16 additions & 10 deletions

File tree

docs/101_introduction.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
# Introduction
22

3-
Jacquard is a deterministic routing system for ad hoc shaped networks. It provides a stable routing abstraction and seven in-tree routing engines: `pathway` for explicit-path routing, `field` for corridor-envelope routing over a continuously updated field model, `batman-bellman` for Bellman-Ford-enhanced next-hop routing, `batman-classic` for spec-faithful BATMAN IV next-hop routing, `babel` for RFC 8966 distance-vector routing with bidirectional ETX and feasibility distances, `olsrv2` for OLSRv2 link-state routing, and `scatter` for bounded deferred-delivery diffusion routing. It is designed so a host can add external routing engines through the same contract.
3+
Jacquard is a deterministic routing system for ad hoc shaped networks. It provides a stable routing abstraction above the concrete routing algorithm. A host composes one or several engines behind the same contract, whether those engines ship with Jacquard or come from a 3rd party.
44

5-
These engines differ in what they publish. Pathway exposes an explicit path, field a corridor envelope, the proactive engines only next-hop visibility, and scatter an opaque viability claim. The shared routing contract carries canonical identity and lifecycle regardless of that published shape.
6-
7-
Related documents cover the rest of the system:
8-
9-
- [Core Types](201_core_types.md) describes the model objects, pipeline, observation, and world-extension surfaces.
10-
- [Time Model](202_time.md) defines the deterministic time rules.
11-
- [Routing Engines](303_routing_engines.md) specifies the engine contract, host runtime-effect boundary, and links to the in-tree engine pages.
12-
- [Router Control Plane](304_router_control_plane.md) explains how a route moves from objective through materialization, maintenance, and teardown.
13-
- [Crate Architecture](999_crate_architecture.md) lists the separation of concerns and implementation policies.
5+
The docs are grouped numerically. The 200s cover the shared model and time. The 300s specify contract surfaces, simulator architecture, and experimental methodology. 400s contain one implementation spec per in-tree engine plus the reference client composition. 500s are 3rd-party developer guides for running simulations, assembling clients, and building custom components. [Crate Architecture](999_crate_architecture.md) is the workspace architecture reference.
146

157
## Scope
168

@@ -36,6 +28,20 @@ When a routing engine needs local coordination, Jacquard allows it to expose a s
3628

3729
Jacquard also allows a host-owned policy engine to compose routing engines through a neutral substrate contract. That means multiple routing engines may be used together, but the shared layer does not treat one canonical route as simultaneously owned by several unrelated engines. Composition happens through explicit carrier leases and layer parameters above the routing-engine boundary.
3830

31+
## In-Tree Engines
32+
33+
Jacquard ships seven in-tree routing engines as concrete demonstrations of the contract:
34+
35+
- `pathway` for explicit-path routing
36+
- `field` for corridor-envelope routing over a continuously updated field model
37+
- `batman-bellman` for Bellman-Ford-enhanced next-hop routing
38+
- `batman-classic` for spec-faithful BATMAN IV next-hop routing
39+
- `babel` for RFC 8966 distance-vector routing with bidirectional ETX and feasibility distances
40+
- `olsrv2` for OLSRv2 link-state routing
41+
- `scatter` for bounded deferred-delivery diffusion routing
42+
43+
These engines differ in what they publish. Pathway exposes an explicit path, field a corridor envelope, the proactive engines only next-hop visibility, and scatter an opaque viability claim. The shared routing contract carries canonical identity and lifecycle regardless of that published shape.
44+
3945
## Design Commitments
4046

4147
Jacquard is fully deterministic. It uses typed time, typed ordering, explicit bounds, and explicit ownership objects instead of ambient runtime assumptions.

0 commit comments

Comments
 (0)