"Needs Docs" Job Queue

[jamesmunns]

Please leave comments here for things that need docs, and we'll document them!

The goal is to make reporting things easy, and to give us a todo list we can chew through.

• [ ] Document making a kernel event loop

[spookyvision]

My questions were already all answered but it could probably use a writeup:

how to use kernel.tick() and timer.{force_}advance to build a main loop

[hawkw]

• [ ] it would also probably be nice to have all the dev environment setup docs in centralized location (e.g. maybe a BUILD.md or CONTRIBUTING.md --- we have a bit of stuff in the README, but not very much, and the D1 platform impl has this in its own README, but i'm not sure how easy it is to find any of that. there's also no "here's where to install just so you can use the justfile" instructions
• [ ] crowtty is completely undocumented except for its CLI help

[hawkw]

"how to make a kernel event loop" docs can probably reference https://mycelium.elizas.website/maitake/scheduler/index.html#executing-tasks and https://mycelium.elizas.website/maitake/time/timer/struct.timer#driving-timers

[Aloso]

Please set the git-repository-url option (documented here), then mdBook includes a GitHub link in the top right corner on every page 🙂

[hawkw]

• [x] pomelo should probably be mentioned in the main readme