Bits Documentation#

Customer- and operator-facing documentation for the Bits campus platform. The directory is organised in a flat layout today; the structure below is what a future Hugo site can absorb without reshuffling.

The Phase 1 docs live elsewhere (see the project plans in plans/). The pages here cover Phase 2 — the V2 surfaces (groups + chapters, mentorship, chapter events, marketplace, expanded search) plus the staff HR carryover.

Architecture#

• phase2-architecture.md — the membership facade, background job runner, and search infrastructure that Stage 15 introduced. Read this first.
• phase2-architecture-dependencies.md — dependency graph showing which Phase 2 surface depends on which platform piece, with file-path citations.
• campus-tab-and-chapter-events.md — Stage 18 user guide for the Campus tab, chapter events, and per-category announcement subscriptions.

Per-role user guides#

Organised under role-guides/<role>/. Each guide has a one-paragraph summary, a “Who this is for” line, the surface walkthrough, and a “Common issues” section.

Alumni#

• role-guides/alumni/chapters-and-groups.md — joining your chapter, posting in groups, private-group request flow.
• role-guides/alumni/mentorship-as-mentor.md — mentor application, accepting matches, scheduling sessions.
• role-guides/alumni/marketplace.md — browsing deals, redeeming coupons, audience scoping.
• role-guides/alumni/search-and-recommendations.md — global search behaviour, recommendation rails, the Why? tooltip.

Students#

• role-guides/student/mentorship-as-mentee.md — mentee application, accepting matches, sessions, notes visibility.
• role-guides/student/groups-and-search.md — joining interest groups, using global search.

Faculty#

• role-guides/faculty/groups-and-events.md — Campus tab, joining groups, chapter events as a guest speaker.

Parents#

• role-guides/parents/campus-and-announcements.md — what parents can read on the Phase 2 surfaces; what is and isn’t visible.

Staff#

• role-guides/staff/leave-and-payroll.md — submitting leave requests, viewing payroll, downloading payslips.

Admin#

• role-guides/admin/phase2-admin-overview.md — pointer page covering every Phase 2 admin surface and capability.

Operational handbooks#

Detailed step-by-step references for the people running a surface day-to-day. These go beyond the role guides into state machines, edge cases, performance budgets, and escalation paths.

• handbooks/group-admin-handbook.md — group + chapter admin handbook: create, moderate, manage members, post announcements, run chapter events.
• handbooks/mentorship-operations-guide.md — programme operator’s guide: programme setup, mentor onboarding, match SLAs, quality signals, escalation paths.
• handbooks/marketplace-partner-onboarding.md — partner onboarding workflow: application, deal authoring, audience scoping, cap mechanics, redemption monitoring, payout settlement.

Conventions#

• Plain CommonMark, no Hugo shortcodes. Front-matter is minimal (title, weight).
• File-path citations point at real source files; line numbers are approximate to the codebase at Stage 23 cut.
• Where the Phase 2 plan describes a feature that did not ship in this release, the page includes a > Note: planned but not yet implemented in this release. callout so readers can tell the difference between current-state and roadmap.