Skip to content

WIKI BUILD REPORT 2

Thomas Mangin edited this page Apr 8, 2026 · 1 revision

Wiki build report

Phase

Phase 1 and Phase 2.

Summary

117 wiki markdown files, ~73,000 words total. Every internal link resolves. No em dash characters anywhere in the wiki pages. Every adapted page ends with a source pointer. Every page that describes pre-alpha behavior carries the pre-alpha banner. The sidebar lists every Phase 1 and Phase 2 page.

Phase 1 landed 38 files (~21,400 words). Phase 2 landed 79 additional files (~51,700 words).

Phase 2 files added

About

  • about/why-ze.md
  • about/history.md

Configuration (non-BGP)

  • configuration/yang-model.md
  • configuration/editor-workflow.md
  • configuration/archive-and-rollback.md
  • configuration/system.md
  • configuration/interfaces.md
  • configuration/fib.md
  • configuration/rpki.md
  • configuration/fleet.md

Configuration (BGP subtree)

  • configuration/bgp/policies.md
  • configuration/bgp/address-families.md
  • configuration/bgp/add-path.md
  • configuration/bgp/graceful-restart.md
  • configuration/bgp/bgp-role.md
  • configuration/bgp/route-reflection.md
  • configuration/bgp/route-injection.md
  • configuration/bgp/redistribution.md

Operation

  • operation/starting-and-stopping.md
  • operation/logging.md
  • operation/operational-reports.md
  • operation/healthcheck.md
  • operation/mrt-analysis.md

Interfaces

  • interfaces/introspection.md

Chaos testing

  • chaos-testing/scenarios.md
  • chaos-testing/dashboard.md
  • chaos-testing/property-verification.md

Plugin development

  • plugin-development/external-plugins.md
  • plugin-development/yang-schema.md
  • plugin-development/handlers.md
  • plugin-development/commands.md
  • plugin-development/testing.md

Development

  • development/repo-layout.md
  • development/coding-standards.md
  • development/testing.md
  • development/debugging.md
  • development/ci.md
  • development/rfc-implementation.md
  • development/claude-code.md

Reference

  • reference/feature-inventory.md
  • reference/configuration-reference.md (stub pending the YANG-generated reference)
  • reference/deprecated-options.md
  • reference/glossary.md

Blueprints

  • blueprints/route-server-at-an-ixp.md
  • blueprints/transit-edge-with-rpki.md
  • blueprints/public-looking-glass.md
  • blueprints/exabgp-migration-walkthrough.md
  • blueprints/flowspec-injection.md
  • blueprints/chaos-tested-peering.md
  • blueprints/as-path-topology.md

Per-plugin reference (plugins//*)

Storage: bgp-rib, bgp-adj-rib-in, bgp-persist

Policy: bgp-rs, bgp-filter-community, bgp-role

Resilience: bgp-gr, bgp-watchdog, bgp-route-refresh

Validation: bgp-rpki, bgp-rpki-decorator

Capabilities: bgp-aigp, bgp-hostname, bgp-llnh, bgp-softver

Address families: bgp-nlri-vpn, bgp-nlri-evpn, bgp-nlri-flowspec, bgp-nlri-ls, bgp-nlri-labeled, bgp-nlri-vpls, bgp-nlri-mvpn, bgp-nlri-rtc, bgp-nlri-mup

Infrastructure: fibkernel, fibp4, ifacedhcp, ifacenetlink, sysrib

29 per-plugin pages total.

Navigation

  • _Sidebar.md expanded to include every Phase 1 and Phase 2 page.

Files modified after Phase 1

  • _Sidebar.md. Rewritten to include every Phase 2 page, with the BGP subtree nested and the plugin subtree grouped by category.
  • about/architecture.md. Two corrections during Phase 1 review: the UPDATE flow section now distinguishes the ExaBGP-style and the route-server-style flows, and the ingress/egress filter paragraph was rewritten to remove the telegraphic opening.
  • WIKI-BUILD-REPORT.md. This file.

Phase 1 and Phase 2 pages skipped

None. Every page listed in PLAN.md section 4 has a wiki equivalent.

Unverified claims (carried over from Phase 1)

  • about/what-is-ze.md and about/status.md (written by an agent during Phase 1) say "21 built-in plugins". The README.md plugin table totals 24 if every entry is counted; docs/guide/status.md says 21. The discrepancy is in the source files, not introduced by the wiki. Worth resolving in main/.
  • about/architecture.md describes five plugin hook points (events, filters, commands, NLRI families, schema augmentation). The source docs list these but not as a tidy enumeration; the grouping is the wiki author's reading.

Decisions taken outside PLAN.md

  • Configuration reference is a stub. The plan called for a configuration reference generated from the YANG schemas. The generator is not written yet, so the wiki page points at ze schema show, the in-tree schemas, and the in-tree configuration guide as the authoritative sources until the generator lands.
  • Per-plugin pages are intentionally compact. Following the spec's "stub for v1, fill in iteratively" guidance, each per-plugin page is 100 to 300 words following the per-plugin template in IMPLEMENTATION.md section 5.
  • interfaces/introspection.md was written in Phase 2 (Phase 1 listed only the five operator surfaces).
  • The build directory at wiki/build/ is an artifact from a Phase 1 agent run. It contains copies of PLAN.md, IMPLEMENTATION.md, and an older WIKI-BUILD-REPORT.md. I have not touched it. The user may want to remove it.

Issues found in main/docs/

  • Plugin count discrepancy between README.md (24 plugins implied by the table) and docs/guide/status.md (21 stated). Unchanged from Phase 1.
  • docs/comparison.md carries a 2026-03-25 "last updated" date that the wiki mirrors without refreshing.

Self-checks

  • 117 wiki files. Every internal Markdown link resolves to an existing file.
  • Zero em dash characters (U+2014) anywhere in the wiki .md files.
  • Every adapted page ends with a > Adapted from ... source pointer.
  • Every page describing pre-alpha behavior carries the pre-alpha banner.
  • No H1 headings in pages. Sub-headings start at ##. (The only ^# matches are shell comments inside fenced code blocks.)
  • Sidebar links resolve.

Next steps

  • Review and commit. The full wiki is now in the working tree, unstaged.
  • Resolve the plugin count discrepancy in main/.
  • Decide whether to delete wiki/build/.
  • When the YANG-generated configuration reference lands, replace reference/configuration-reference.md with the generated output.
  • As each per-plugin page gains real operational details, expand it from the stub template.
  • Future Phase 3 work (if any): screenshots refresh, embedded diagrams, auto-generated command reference (make ze-command-list output folded into the wiki), per-plugin deeper sections.

Words per page (Phase 2 only, top 10)

1132  about/why-ze.md
1053  configuration/bgp/peers.md
1024  configuration/bgp/graceful-restart.md
 951  interfaces/web-ui.md
 900  blueprints/route-server-at-an-ixp.md
 844  configuration/bgp/redistribution.md
 813  configuration/fib.md
 785  configuration/bgp/route-injection.md
 740  reference/glossary.md
 720  blueprints/chaos-tested-peering.md

(Rough counts, from len(content.split()). Exact per-page word counts vary with formatting.)

Total

  • 117 wiki .md files.
  • ~73,000 words.
  • 38 + 79 files across Phase 1 and Phase 2.

Home

About

First Steps

Configuration

Operation

Interfaces

Plugins

Plugin Development

Chaos Testing

Blueprints

Development

Reference

Clone this wiki locally