Skip to content

History / FormatStyle Design

Revisions

  • the example the page told you to write was refused by the version it documents

    @cpflat cpflat committed Aug 25, 2026
  • a hook is a group now, and the pages say so

    @cpflat cpflat committed Aug 25, 2026
  • wiki: say what each feature is for, before saying what it does Twenty-two sections opened by restating their own name - "NodeClass defines device types and their basic properties", "Define automatic parameter assignment" - or by going straight into a table. A reader who does not already know why the feature exists learns nothing from the syntax that follows. Each now opens with what it is useful for. The existing text is untouched; this is one paragraph added in front of it. The six class definitions carried the most weight, since the class system is where a topology's shape is decided and "NodeClass defines device types" says nothing about why there is one class per kind of object. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

    @cpflat cpflat committed Aug 14, 2026
  • wiki: finish the terminology change, and give every page a way out The substitution left the word in a few places and left Basic-Concepts arguing with its own definition: the callout said a topology is both files, and the page below kept saying "change topology" for editing the DOT file. A reader ends a page believing whatever it said last. - the graph is called the graph where the graph is meant - "topology file" only where a platform is named; the cross-platform places name topo.yaml and spec.yaml instead - Upgrading names netroub, which the CHANGELOG already warns about, as the downstream tool that reads generated files by path - Basic-Concepts and Command-Reference had no outgoing links at all; both now end somewhere, and the class table and param_rule reach the pages that explain them - two links pointed at nothing (a Graphviz-style path, an anchor with a slash in it) Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

    @cpflat cpflat committed Aug 13, 2026
  • wiki: say topology where a topology is meant, and stop saying scenario scenario is netroub's word - a configuration together with the events that happen in it, defined in its papers and in its own schema, where a scenario is a topology plus events. This documentation had taken it for what a reader writes, which would have left two projects by the same author using one word for two things. What you write - the DOT file and the YAML that configures it - is a topology, which is how this field already speaks: containerlab calls its own file a topology definition and puts the nodes' images and configuration in it. Basic-Concepts and Home say so before the word is used. Where only the graph is meant the pages now say the DOT file, and topology file is left to mean what a platform reads.

    @cpflat cpflat committed Aug 13, 2026
  • wiki: make the examples run, and say what virtual means now The two Complete Examples printed a loopback address from a scenario that never asked for one, and had no interface policy either - copied out and run, they stopped at 'no segment for layer ip'. Both build now; containerlab's generated topo.yaml is the real output of the example above it. The FRR page told readers to write 'conf t' in a template whose FormatStyle already writes it, which would have produced it twice. Its topology output had no network-mode: none, the platform-node paragraph said kind was unnecessary when only image is, and interface_class: is not a key any more than node_class: was. virtual now has a section: it means something different on a node, an interface and a connection, and since 0.8.0 a virtual interface no longer takes its link with it - which nobody was told. Also: TiNET's shell failure mode is not containerlab's (its output is piped to a shell on the host), FormatStyle-Design carried a backward compatibility section for fields that no longer exist, and four cross-page anchors pointed at headings that were renamed.

    @cpflat cpflat committed Aug 12, 2026
  • fix what the sweep left behind: names, examples, and the rules they depend on The pages written from scratch were checked against the code; the older ones were not, and the site contradicted itself. The default interface prefix said net in the reference and eth in the upgrade page. The frr FormatStyle was called frrVtysh, which never existed. TiNET's mounts had no $PWD and grew a sysctls section it does not generate; containerlab's examples had no network-mode: none, in a page that explains it is there. The tutorial's first YAML example used keys that do not exist, which 0.8.0 rejects outright, and Best-Practices told readers to run subcommands that were never implemented. Added what everything else leans on: how several classes on one object combine and which one wins, scope: group and what a group-scoped file is for, and the per-machine topology and spec files on the two platform pages. Kathara and assert are in the module tables now, so the new page can be reached.

    @cpflat cpflat committed Aug 12, 2026
  • update Wiki for v0.6.0 FormatStyle changes

    @cpflat cpflat committed Dec 3, 2025