Skip to content

WIKI BUILD REPORT 1

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

Wiki build report

Phase

Phase 1.

Summary

38 markdown files, ~21,400 words. Every Phase 1 page from PLAN.md section 5 exists. No em dash characters anywhere. Every adapted page has a source pointer. Every page that describes pre-alpha behavior has the pre-alpha banner. All internal links resolve.

Files created

Structure

  • Home.md (rewritten as a card-grid landing page)
  • _Sidebar.md (Phase 1 sidebar)
  • _Footer.md (license, repo, Discord, edit link)

About

  • about/index.md
  • about/what-is-ze.md
  • about/architecture.md
  • about/status.md

First steps

  • first-steps/index.md
  • first-steps/install.md
  • first-steps/quick-start.md
  • first-steps/exabgp-migration.md
  • first-steps/cli-tour.md
  • first-steps/web-ui-tour.md

Configuration

  • configuration/index.md
  • configuration/overview.md
  • configuration/bgp/index.md
  • configuration/bgp/peers.md

Operation

  • operation/index.md
  • operation/show-commands.md
  • operation/monitoring.md
  • operation/upgrade-and-restart.md

Interfaces

  • interfaces/index.md
  • interfaces/cli.md
  • interfaces/web-ui.md
  • interfaces/looking-glass.md
  • interfaces/mcp.md
  • interfaces/rest-api.md

Plugins and plugin development

  • plugins/index.md
  • plugin-development/index.md
  • plugin-development/go-plugins.md

Chaos testing and blueprints

  • chaos-testing/index.md
  • blueprints/index.md

Development

  • development/index.md
  • development/building.md
  • development/contributing.md

Reference

  • reference/index.md
  • reference/command-reference.md
  • reference/comparison.md

Files modified

  • Home.md. Replaced the original landing page with the Phase 1 card-grid layout.

Phase 1 pages skipped

None. Every page in the Phase 1 list from PLAN.md section 5 was written.

Phase 2 pages explicitly excluded from the sidebar

The sidebar lists only Phase 1 pages so every link resolves. The pruned-out entries (about/why-ze, about/history, the deeper configuration pages, the deeper operation pages, interfaces/introspection, the rest of plugin-development, the deeper chaos-testing pages, every blueprint, the deeper development pages, the deeper reference pages, every per-plugin reference page) are documented in PLAN.md and will be added to the sidebar as they are written.

Unverified claims

  • what-is-ze.md and status.md (written by an agent) say "21 built-in plugins". The README plugin table totals 24 if every entry is counted; the in-tree status.md says 21. The discrepancy is in the source files, not introduced by the wiki. May be 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.
  • about/architecture.md says IPv4/IPv6 unicast and multicast are built into the engine "because they predate the plugin interface". The README confirms they are built into the engine; the "predate" reasoning is the wiki author's inference.

Decisions taken outside PLAN.md

  • The sidebar was pruned to Phase 1 pages only so every link in Home.md and _Sidebar.md resolves. Phase 2 pages will be added to the sidebar as they land.
  • Home.md was rewritten as a card grid with one row per audience (try, install, configure, plugins, automate, contribute) per PLAN.md section 4.1, but the in-line "ExaBGP migration walkthrough" link in the card grid was replaced with a Phase 2 note because that blueprint is not yet written.
  • about/architecture.md uses an ASCII flow rather than embedding the ze-architecture.svg (the spec said to link to it, which it does).
  • The pre-alpha banner is on the index pages too, since they reference behavior that may change.
  • chaos-testing/index.md, blueprints/index.md, and the section index pages link to in-tree docs for content not yet adapted into the wiki, with an explicit "Phase 2" note.
  • The comparison.md page is opinionated and condensed: a short maturity table, a "where Ze fits" paragraph, an honest "what Ze has and does not have" pair of lists, and a "if you want X, use Y" pointer. The full feature matrix lives in-tree.

Issues found in main/docs/

  • Plugin count discrepancy between README.md (24 plugins implied by the table) and docs/guide/status.md (21 stated). Not fixed in main/. Worth a follow-up issue.
  • docs/comparison.md carries a 2026-03-25 "last updated" date. The wiki page mirrors that date contextually rather than refreshing it.

Next steps for Phase 2

The Phase 2 backlog is the rest of PLAN.md section 4. Suggested order, in increasing effort:

  1. About: about/why-ze.md (existing, light adaptation), about/history.md (new).
  2. Configuration: the rest of the configuration tree under configuration/. Most are existing in-tree docs that need adaptation. configuration/yang-model.md and configuration/editor-workflow.md are the ones operators ask about most.
  3. Operation: the remaining operation pages (starting-and-stopping, logging, operational-reports, healthcheck, mrt-analysis).
  4. Interfaces: interfaces/introspection.md.
  5. Plugin development: external-plugins.md, yang-schema.md, handlers.md, commands.md, testing.md. Most are existing.
  6. Chaos testing: scenarios.md, dashboard.md, property-verification.md.
  7. Per-plugin reference pages under plugins/<category>/. This is the long tail. Stub them first, fill iteratively.
  8. Blueprints: write all seven listed in PLAN.md section 4.10. Each one is end-to-end and needs its own attention.
  9. Development: the remaining development pages.
  10. Reference: feature-inventory.md, configuration-reference.md (auto-generate from schemas), deprecated-options.md, glossary.md.

After Phase 2 lands, the sidebar should be expanded to include the new pages.

Self-checks performed

  • No em dash character (U+2014) in any wiki file.
  • Every page has a sub-heading hierarchy starting at ##. No H1 headings (verified by grep against the Markdown line-start # pattern; the only matches were shell comments inside fenced code blocks).
  • Every page that describes pre-alpha behavior carries the pre-alpha banner.
  • Every page adapted from main/docs/ ends with the > Adapted from ... source pointer.
  • All 38 wiki files were scanned for internal Markdown links; every internal link resolves to an existing file. No broken cross-links.
  • Page lengths fit the targets in PLAN.md section 6: guides 200-800 words, reference 800-2000, architecture under 1500.

Words by page

303  Home.md
89   _Sidebar.md
11   _Footer.md
147  about/index.md
685  about/what-is-ze.md
1132 about/architecture.md
1124 about/status.md
293  first-steps/index.md
466  first-steps/install.md
584  first-steps/quick-start.md
703  first-steps/exabgp-migration.md
592  first-steps/cli-tour.md
682  first-steps/web-ui-tour.md
103  configuration/index.md
746  configuration/overview.md
111  configuration/bgp/index.md
1053 configuration/bgp/peers.md
188  operation/index.md
531  operation/show-commands.md
569  operation/monitoring.md
755  operation/upgrade-and-restart.md
194  interfaces/index.md
755  interfaces/cli.md
951  interfaces/web-ui.md
717  interfaces/looking-glass.md
520  interfaces/mcp.md
563  interfaces/rest-api.md
684  plugins/index.md
571  plugin-development/index.md
845  plugin-development/go-plugins.md
735  chaos-testing/index.md
290  blueprints/index.md
135  development/index.md
530  development/building.md
663  development/contributing.md
155  reference/index.md
1190 reference/command-reference.md
1014 reference/comparison.md

Total: ~21,400 words across 38 files.

Home

About

First Steps

Configuration

Operation

Interfaces

Plugins

Plugin Development

Chaos Testing

Blueprints

Development

Reference

Clone this wiki locally