docs: bring the pages back in line with what the code does - #16
Merged
Conversation
The runbook still said a failed `extra_packages` file stops the build. Since 417d71d it does not: the extras layer retries one file at a time, records what is still missing in /etc/owlab/extras-failed, and `owlab up` reports it after its table and exits non-zero. Both language versions now say that, which is also where the exit-code change belongs -- the reference and the troubleshooting page had it, the procedure that produces it did not. The two-release examples handed every router a `.apk` glob. Since the `pkgmgr.FilterFiles` split each router gets only its own format, so a glob ending in `.apk` leaves the 24.10 router with nothing to install -- reported as a skip, and every assertion after it fails against a router the package never reached. The globs lose the extension, which is what the flag table beside them already promised. Release numbers: README.md, docs/reference.md and examples/ still opened with 25.12.4 while their Russian pairs and images/owlab.yaml had moved to 25.12.5. `tools/pins.sh` deliberately does not read prose, so nothing caught it. The sample `owlab releases` output stays one release behind on purpose. releasing.md said how the image pin is tracked but not that moving it needs `tools/pins.sh bump`, with `check` gating it in ci.yml and pins.yml proposing the bump. STATUS.md dated itself 2026-07-29, credited the Linux job with `owlab doctor` runs that only happen on the macOS and Windows runners, and listed none of the three things that have been verified since. CONTRIBUTING.md counted five cross-compile targets; ci.yml has built six since windows/arm64 was added, and the shell job also covers tools/ and the pins. The action's `install` description carried the same `.apk` glob as the pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation that had drifted from the code. Each fix is traced to a line or a command
output rather than to an impression, and nothing here is a rewrite for tone.
Covers what changed today: the
owlab upexit code, the--installformat filter, thepin gate and
pins.yml, and the release references that the prose keeps outside thegate's reach —
tools/pins.sh checkdeliberately does not read documentation, so theREADME pair and
examples/had drifted apart on their own.Both languages say the same thing again.