Add reference to git repo + docs

2026-04-30 20:41:45 +02:00
parent a09a9da87c
commit 021b522abe
1 changed files with 13 additions and 0 deletions
@@ -620,6 +620,19 @@ The only service I'm a bit apprehensive about - even though I don't think I need
 plan is to let this marinate for a few weeks, and then move the read-path and later on, also the
 write-path to this construction.

+You can find the project at [[git.ipng.ch/ipng/vpp-maglev](https://git.ipng.ch/ipng/vpp-maglev.git)]
+and debian packages are on [[deb.ipng.ch](https://deb.ipng.ch/)]. I wrote some reasonable
+documentation for the project at:
+*   [[docs/design.md](https://git.ipng.ch/ipng/vpp-maglev/src/branch/main/docs/design.md)] on the
+architecture, components, and numbered functional / non-functional requirements. Start here if
+you want the big picture before diving into the code.
+*   [[docs/user-guide.md](https://git.ipng.ch/ipng/vpp-maglev/src/branch/main/docs/user-guide.md)]
+describes the flags, signals, and maglevc command reference.
+*   [[docs/config-guide.md](https://git.ipng.ch/ipng/vpp-maglev/src/branch/main/docs/config-guide.md)]
+shows the full YAML configuration file reference.
+*   [[docs/healthchecks.md](https://git.ipng.ch/ipng/vpp-maglev/src/branch/main/docs/healthchecks.md)]
+is a deepdive on the health state machine, probe scheduling, and rise/fall semantics.
+
 ## What's Next

 Using Maglev has a few significant benefits. Most importantly, I can drain (or weather an outage of)