Guide Review Checklist¶
Use the contribution guide and boilerplate as the shared contract. Help contributors resolve problems; do not reject useful changes for title formatting, labels, or cosmetic wording.
- Correctness: Do the commands work on Uberspace 8? Check paths, runtime requirements, service configuration, and the public application behavior.
- Completeness: Keep the introduction and section order, installation and update instructions, and applicable prerequisite/update notes. Release pages are fine when no feed exists.
- Attribution: Each author has a name and email or URL for the public Hall of Fame. Preserve existing authors and optional organization details.
- Reader safety: Explain destructive steps, protect credentials, and replace default passwords. Make local versus server commands clear.
- Evidence: Record tested versions and what was tested. New guides need a fresh Asteroid test; small prose fixes do not need a new installation.
Automated checks¶
Use explicit files for uncommitted work, --staged for staged changes, or
--all for the full collection. --base REVISION selects the comparison base.
The checks validate metadata, author contacts, logos, registered tags, and
structure. --strict remains accepted for compatibility; all remaining errors
are required fixes. task check also runs unit tests and the strict site build.
Automated checks cannot prove that installation instructions work. Report concrete problems with a suggested correction, distinguish required fixes from optional improvements, and avoid asking contributors to repeat checks that maintainers have already completed.