Skip to content

Lab Guide Review Checklist

We review every contribution and work with you to get it ready for publication. We are here to help, answer questions, and give feedback. We explain any problems we find and suggest concrete corrections or commit a fix directly in your branch.

We make clear which changes are needed before publication and which are optional improvements.

What we look at

  • Correctness: We check whether the commands work on Uberspace 8, including paths, runtime requirements, service configuration, and whether the application is reachable and behaves as described.
  • Completeness: We check the introduction, section order, installation and update instructions, and any relevant prerequisite notes.
  • Attribution: We check that each author has a name and an email address or URL for the public Hall of Fame.
  • Reader safety: We check that credentials are protected and default passwords are changed. We also check that readers can tell which commands run locally and which run on their Asteroid.
  • Evidence: For new Lab Guides, we verify installation and runtime behavior on a fresh Uberspace 8 Asteroid. We discuss any remaining gaps with you.

Automated checks

We run automated checks to catch problems with metadata, author contacts, logos, registered tags, and guide structure and so can you. For committed changes use:

uv run -- python hooks/check_guide.py docs/guides/guide_foo.md

Example output (final line of a successful check):

Guide checklist: passed

How we give feedback

We do not reject useful contributions over title formatting, labels, or cosmetic wording. We help resolve those details, and we do not ask you to repeat checks we have already completed. If something is unclear or untested, we say so and work out the next step with you.