docs: fix dangling references, document Gitea/GitHub mirror split

CONTRIBUTING.md: remove the deleted wii5_modes sketch from the testing
guidance; mention the surviving test/ subsystem sketches instead.

README.md: drop the now-incorrect "hardware schematics" entry from the
repository-layout block (doc/hardware/ was removed earlier). Add a
Repository section naming the Gitea canonical and the GitHub mirror
(https://github.com/SH3D/WII5Firmware) used for community issues and PRs.

SECURITY.md, CODE_OF_CONDUCT.md: point at the GitHub mirror for security
advisories; drop the vague "private GitHub message" path from the CoC.

CHANGELOG: replace the "TODO" placeholder with a real v5.5.1 initial
public release entry.

Doxyfile: rewrite the PROJECT_NUMBER injection example to use
`git describe` instead of the deleted VERSION file.

VERSION: removed. It was bumped by tools/tag_version.sh +
tools/build_version.sh (both deleted in c89c636); build_local.sh injects
WII5_SOFTWARE_VERSION from `git log -1 --pretty=%h` at compile time, so
nothing load-bearing depends on the file.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

CHANGELOG

@@ -1,30 +1,12 @@
-v5.x - 2024
+# Changelog
-* TODO
 
-v1.x
+## v5.5.1 — 2024
-* New BinData for sending/receiving binary data on the Iridium
-* Simplified and improved the button logic.
-* New logging level controls
-* GPS Debug and Passthrough in any mode
-* Better beep for Maths Start
-* Rugged Position Mode
-* Calculate time until next...
 
-v1.0.20
+Initial public open-source release under the Apache License 2.0.
-* Battery And Temperature encouraged to read near boot timed
-* Hold/Click button cycle Improved
-* Power for Buzzer
-* Hold feedback messages for Displaying shutdown time of Maths
-* Sleep period configurable in EEPROM
-* Split non-essential loop out for Maths
-* Mode timeouts
-* Direct maths Hold command
-* Fully working Seep Mode
-
-v1.0.16
-* statusDump - automatically shown at Voltage and Weather to allow Local Server updates
-* Using @WII5,setting,mode,default,{STRING} has worked for a while, added "swap" which switches
-   to sleep if it was capture, otherwise to capture.
-* Updated Test help to remove incorrect documentation.
-* Large number of experimental changes in Maths to facilitate start/stop/reboot
 
+- Firmware merged from the legacy WII3 (watchdog / maths-CPU) and WII1
+  (buoy I/O) lineages.
+- Target: ATmega2560 on the custom WII5 v2 carrier board.
+- Modes: Capture, Position, Sleep, ManualTest, SelfTest, LowBattery.
+- Iridium 9602 / 9603 SBD telemetry; Sparton AHRS-M1/M2 IMU; u-blox
+  NEO-6M/7M GPS; dual SD storage.

CODE_OF_CONDUCT.md

@@ -14,8 +14,8 @@ project space.
 
 If you experience or witness behaviour that violates this code, please
 report it to the maintainers privately via email (see the contact in the
-project README), or via a private GitHub message to a maintainer. Reports
+project README). Reports will be handled confidentially and in good
-will be handled confidentially and in good faith.
+faith.
 
 ## Scope
 

CONTRIBUTING.md

@@ -74,10 +74,10 @@ small worked examples.
 ## Testing
 
 There is no automated test harness for the firmware itself — testing is done
-by flashing onto real hardware and exercising the `wii5_buoy` and
+by flashing onto real hardware and exercising the `wii5_buoy` sketch. The
-`wii5_modes` sketches. The `test/` directory contains smaller sketches
+`test/` directory contains smaller per-subsystem sketches (Iridium, Sparton,
-demonstrating individual subsystems; please add a sketch there if you add a
+GPS, DS18B20, BinData, console commands, pin diagnostics); please add a
-new driver.
+sketch there if you add a new driver.
 
 In your PR, describe:
 - What you tested on (hardware or just compile?)

Doxyfile

@@ -10,8 +10,8 @@
 # --- Project identity --------------------------------------------------------
 PROJECT_NAME           = "WII5 Buoy Firmware"
 PROJECT_BRIEF          = "Firmware for the WII5 wave-measurement buoy (ATmega2560)."
-# PROJECT_NUMBER is normally injected by the build script:
+# PROJECT_NUMBER can be injected at invocation time, e.g.
-#   doxygen <(sed "s/^PROJECT_NUMBER.*/PROJECT_NUMBER = $(cat VERSION | grep version | cut -d= -f2)/" Doxyfile)
+#   doxygen <(sed "s/^PROJECT_NUMBER.*/PROJECT_NUMBER = $(git describe --tags --always)/" Doxyfile)
 # Hardcoded fallback follows.
 PROJECT_NUMBER         = v5.5.x
 

README.md

@@ -112,7 +112,7 @@ A running log of notable real-world deployments lives in `DEPLOYMENTS.md`.
 app/wii5_buoy/        Arduino sketch entry point
 WII5*.{h,cpp}         Firmware source (board root, see Architecture)
 WII5_board_v2.h       Pin/peripheral map for the WII5 v2 board
-doc/                  Design notes, command reference, hardware schematics
+doc/                  Design notes, command reference, generated API docs
 test/                 Smaller per-subsystem test sketches
 tools/                Build, flash, and size-profile helper scripts
                       (env-var driven; copy to *.local.sh to set local
@@ -125,10 +125,24 @@ See [CONTRIBUTING.md](CONTRIBUTING.md). Please also read
 [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) and [SECURITY.md](SECURITY.md)
 before opening issues or PRs.
 
+## Repository
+
+The canonical source is hosted on Gitea:
+
+- **Main repository:** https://gitea.sh3d.com.au/Sh3d/WII5Firmware
+
+A read-only mirror is published on GitHub for community issues and pull
+requests:
+
+- **GitHub mirror:** https://github.com/SH3D/WII5Firmware
+
+Open issues and PRs against the GitHub mirror; changes are reviewed there
+and merged back through the Gitea canonical.
+
 ## Contact
 
 - Maintainer: Scott Penrose <scottp@dd.com.au>
-- Bugs and feature requests: GitHub Issues
+- Bugs and feature requests: [GitHub Issues](https://github.com/SH3D/WII5Firmware/issues)
 - Security issues: see [SECURITY.md](SECURITY.md)
 
 ## License

SECURITY.md

@@ -9,9 +9,10 @@ control of a deployed buoy — **please do not open a public GitHub issue**.
 
 Instead, report it privately:
 
-- Open a private security advisory via the GitHub repository's
+- Open a private security advisory via the GitHub mirror's **Security**
-  **Security** tab → "Report a vulnerability", or
+  tab → "Report a vulnerability":
-- Email the maintainer: Scott Penrose <scottp@dd.com.au>
+  https://github.com/SH3D/WII5Firmware/security/advisories/new
+- Or email the maintainer: Scott Penrose <scottp@dd.com.au>
 
 Please include:
 

VERSION

@@ -1,2 +0,0 @@
-version=v5.5.1
-short=c0b356d