Documentation

Run your space, documented

Everything hackerspace.sh does, written down. Organized the Diátaxis way: learn with tutorials, get things done with how-to guides, look up the details in reference, and understand the why in explanation.

Start here

Tutorials

Learning-oriented lessons that take you from nothing to a working space, step by step.

Set up your space Onboard your first members Run your first class Track dues, end to end

Get a task done

How-to guides

Task-oriented recipes for a specific goal, assuming you already know the basics.

Import members from a spreadsheet Create role-granting invite links Configure the onboarding flow Connect payments & reconcile dues Set up recurring Stripe dues Build a form or signable waiver Set up equipment & reservations Connect a door controller Create tasks & recurring chores Track projects Use comms & the forum Write ops docs & store secrets Run a proposal to a vote File & manage an incident Publish & version a policy Customize roles, tiers & areas

Look it up

Reference

Information-oriented, exhaustive descriptions of the machinery. Dry and accurate.

Modules overview Roles & permissions Members: statuses, tiers & fields Governance reference Payments & dues reference Access control & doors reference Forms & waivers reference Classes, certifications & equipment Integrations, cron & webhooks

Understand why

Explanation

Understanding-oriented discussion of how things fit together and why they are built this way.

Architecture overview The multi-space & permissions model How governance works Security & privacy model Dues & reconciliation, explained