Working on the platform

The repositories

Source is under the Kanu-Hawaii GitHub organization . The volunteer platform, the main site, and this documentation site are separate repositories with separate deploys.

Developer documentation lives in the repositories

Each repository carries its own docs/ directory covering architecture, the database, testing, and local development, and that is the canonical copy. It ships in the same pull request as the code it describes, which is the only arrangement where documentation and behaviour cannot drift apart.

This site is not a second home for it. What belongs here is documentation for using the platform: volunteers, organizers, and partners embedding it. What belongs in a repository is documentation for changing it.

The dividing question is who the reader is. An organizer asking “how do I invite a colleague” belongs here. A contributor asking “how do I run the test suite” belongs in the repository.

Contributing to these docs

Every page on this site is an MDX file. The Edit this page link at the bottom of each one opens it on GitHub, so a correction is a pull request and takes about a minute.

Corrections are genuinely welcome. A guide that no longer matches the screen is worse than no guide at all, because somebody follows it and then doubts themselves rather than the documentation.