Corrections
The log of substantive corrections made to ZigProxy pages after publication, with the date, the claim that was wrong and the claim that replaced it.
Technical reference content goes out of date and occasionally goes out wrong. When it does, the fix belongs in public rather than silently in the page.
The policy#
- Substantive corrections are logged here. A correction is substantive if it changes a factual claim, a default value, a version boundary, or the practical advice a reader would act on.
- Fixes are made in the page itself, not appended as a note, so nobody reads the wrong version. The page's Updated date changes at the same time.
- Typographic, formatting and link fixes are not logged. Neither are expansions that add new material without changing what was already there.
- Removals are logged too. If a claim is withdrawn because it could not be verified on re-reading, that is recorded here with the reason.
Correction log#
No substantive corrections have been logged yet. This page was published alongside the initial set of guides, and entries will appear here as they occur.
Each entry will record:
| Field | Meaning |
|---|---|
| Date | When the correction was published |
| Page | Which page changed |
| Was | The claim as originally published |
| Now | The claim as it now reads |
| Why | The source or version that prompted the change |
Reporting an error#
Send the page URL, the specific sentence, and what contradicts it: a specification section, a documentation page, a source file, or a reproducible observation with the exact software version. See contact.
Reports that include a primary source are actioned fastest. If you are reporting behaviour that differs on your version, the version number is the most important part of the report, because the answer is often that both statements are correct for different releases and the page needs to say so.
The full method is described in editorial standards.