Files
EvoBGP/internal/birdfmt/doc.go
T
Denozordec aff27e8f7b
CI / changes (push) Successful in 11s
CI / openapi (push) Has been skipped
CI / go (push) Successful in 43s
CI / docker-web (push) Has been skipped
CI / docker-bird (push) Has been skipped
CI / bird2 (push) Successful in 21s
CI / docker-go (push) Successful in 3m41s
docs: update AGENTS and README with engineering rules and guidelines
- Added engineering rules references in AGENTS.md for code changes and specific areas (web, BIRD).
- Enhanced README.md to include links to engineering rules for different development areas.
- Updated birdfmt documentation to specify engineering rules for BIRD/BGP/IP.
- Clarified UI development guidelines in web/README.md to follow shadcn-svelte documentation and repository rules.
2026-05-20 00:14:14 +07:00

23 lines
1015 B
Go

// Engineering rules for BIRD/BGP/IP: .cursor/rules/networking-bird.mdc
//
// Package birdfmt builds BIRD 2 configuration text: main bird.conf skeleton, include
// fragments under bird.d/, export filters, static route protocols, BGP templates, and
// BGP peer protocols (from template or standalone). Runtime helpers parse-check configs
// (bird -p) and reload (birdc configure).
//
// # Layout
//
// Operator keeps a stable bird.conf (or generated skeleton) next to EvoBGP fragments:
//
// bird.conf — router id, protocol device, protocol direct, include lines
// bird.d/evobgp_*.conf — generated prefixes, filters, BGP templates, peers (names from constants)
//
// Include order should list filter definitions before protocols that reference them
// (see StandardIncludeFragments).
//
// # Apply workflow
//
// 1. Write new fragment files to a staging directory, run bird -c <bird.conf> -p.
// 2. Atomically swap staging → live config dir, then birdc configure (see BirdCtl).
package birdfmt