-
Notifications
You must be signed in to change notification settings - Fork 2
WIKI BUILD REPORT 1
Phase 1.
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.
-
Home.md(rewritten as a card-grid landing page) -
_Sidebar.md(Phase 1 sidebar) -
_Footer.md(license, repo, Discord, edit link)
about/index.mdabout/what-is-ze.mdabout/architecture.mdabout/status.md
first-steps/index.mdfirst-steps/install.mdfirst-steps/quick-start.mdfirst-steps/exabgp-migration.mdfirst-steps/cli-tour.mdfirst-steps/web-ui-tour.md
configuration/index.mdconfiguration/overview.mdconfiguration/bgp/index.mdconfiguration/bgp/peers.md
operation/index.mdoperation/show-commands.mdoperation/monitoring.mdoperation/upgrade-and-restart.md
interfaces/index.mdinterfaces/cli.mdinterfaces/web-ui.mdinterfaces/looking-glass.mdinterfaces/mcp.mdinterfaces/rest-api.md
plugins/index.mdplugin-development/index.mdplugin-development/go-plugins.md
chaos-testing/index.mdblueprints/index.md
development/index.mddevelopment/building.mddevelopment/contributing.md
reference/index.mdreference/command-reference.mdreference/comparison.md
-
Home.md. Replaced the original landing page with the Phase 1 card-grid layout.
None. Every page in the Phase 1 list from PLAN.md section 5 was written.
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.
-
what-is-ze.mdandstatus.md(written by an agent) say "21 built-in plugins". The README plugin table totals 24 if every entry is counted; the in-treestatus.mdsays 21. The discrepancy is in the source files, not introduced by the wiki. May be worth resolving inmain/. -
about/architecture.mddescribes 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.mdsays 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.
- The sidebar was pruned to Phase 1 pages only so every link in
Home.mdand_Sidebar.mdresolves. Phase 2 pages will be added to the sidebar as they land. -
Home.mdwas rewritten as a card grid with one row per audience (try, install, configure, plugins, automate, contribute) perPLAN.mdsection 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.mduses an ASCII flow rather than embedding theze-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.mdpage 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.
- Plugin count discrepancy between
README.md(24 plugins implied by the table) anddocs/guide/status.md(21 stated). Not fixed inmain/. Worth a follow-up issue. -
docs/comparison.mdcarries a 2026-03-25 "last updated" date. The wiki page mirrors that date contextually rather than refreshing it.
The Phase 2 backlog is the rest of PLAN.md section 4. Suggested order, in increasing effort:
-
About:
about/why-ze.md(existing, light adaptation),about/history.md(new). -
Configuration: the rest of the configuration tree under
configuration/. Most are existing in-tree docs that need adaptation.configuration/yang-model.mdandconfiguration/editor-workflow.mdare the ones operators ask about most. - Operation: the remaining operation pages (starting-and-stopping, logging, operational-reports, healthcheck, mrt-analysis).
-
Interfaces:
interfaces/introspection.md. -
Plugin development:
external-plugins.md,yang-schema.md,handlers.md,commands.md,testing.md. Most are existing. -
Chaos testing:
scenarios.md,dashboard.md,property-verification.md. -
Per-plugin reference pages under
plugins/<category>/. This is the long tail. Stub them first, fill iteratively. -
Blueprints: write all seven listed in
PLAN.mdsection 4.10. Each one is end-to-end and needs its own attention. - Development: the remaining development pages.
-
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.
- 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.mdsection 6: guides 200-800 words, reference 800-2000, architecture under 1500.
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.
Unreviewed draft. This wiki was authored in bulk and has not been reviewed. File corrections on the issue tracker.
- Overview
- YANG Model
- Editor Workflow
- Archive and Rollback
- System
- Interfaces
- VRRP
- BFD
- FIB
- OSPF
- IS-IS
- MPLS / LDP / RSVP-TE
- RSVP-TE
- SRv6
- Static Routes
- Policy Routing
- Firewall
- Traffic Control
- Class of Service
- L2TP/PPP
- PPPoE
- VPP Data Plane
- RPKI
- IPsec VPN
- TACACS+ AAA
- RADIUS AAA
- AS112 DNS
- Authorization
- Fleet
- BGP
- Starting and Stopping
- Show Commands
- Monitoring
- Flow Export
- DDoS Mitigation
- Anomaly Detection
- Health Checks
- Audit Trail
- Production Diagnostics
- Logging
- Operational Reports
- Healthcheck
- Self-Update
- Zero-Touch Provisioning
- MRT Analysis
- Upgrade and Restart
- Storage
- Policy
- Core
- Resilience
- Validation
- Capabilities
- Address Families
- Protocol
- Subsystems
- Infrastructure
- Route Server at an IXP
- Transit Edge with RPKI
- Public Looking Glass
- ExaBGP Migration Walkthrough
- FlowSpec Injection
- Chaos-Tested Peering
- AS Path Topology