These are technical docs for Resident Council products and governance. They explain architecture, interfaces, data, security boundaries, and operations in language that residents and technical readers can follow.
House Desk and Pub are documented separately in the IHNYC Service Docs, reflecting their independent stewardship, authorization, and release paths.
Where to begin
| If you want to understand… | Start with |
|---|---|
| How the products fit together | System overview |
| One RC product from surface to storage | Service directory |
| Shared RC routes and response shapes | API contracts |
| Authentication and authorization boundaries | Security model |
| How a service is deployed or recovered | The product’s how-to/ section |
| Whether the docs match the current repositories | July 2026 documentation audit |
Page types
| Page type | Best for | What to expect |
|---|---|---|
| Tutorial | Learning or completing a first task | A guided sequence with a visible outcome |
| How-to | Operating or troubleshooting | A goal-focused procedure that assumes some context |
| Explanation | Understanding behavior and tradeoffs | Concepts, architecture, diagrams, and rationale |
| Reference | Looking up an exact detail | Routes, schemas, parameters, configuration, or commands |
| Design document | Understanding a specific change | Point-in-time intent and decisions; verify its status |
| Announcement | Learning what shipped | A dated, audience-friendly change summary |
Reading status labels
- Active describes a current service or current guidance.
- Shipped describes a completed change or announcement.
- Planned, approved, or dev describes work that may not be live.
- Legacy is retained for migration or historical context.
- Decommissioned describes a retired service that should not be treated as operational.
When a point-in-time design document conflicts with an active service page or runbook, use the active page. The service’s source repository remains authoritative for exact deployed behavior.
Finding information
- Use Search for a feature name, error message, route, or acronym.
- Use Documentation to move between RC overview, services, platform reference, and governance.
- Use the table of contents on longer pages to jump to a section.
- On a larger screen, use Reader mode to hide navigation and focus on a long procedure.
If a term is unfamiliar, open the glossary. If something is missing or inaccurate, see Contributing and maintaining. The July 2026 documentation audit records the latest repository-by-repository coverage review.