Skip to content

How To Read This Site

Public Summary

Start with Architecture, then go to Backend or Frontend based on your role. Use Deployment if you are running environments or releases.

Internal Details

Suggested Reading Paths

  • New engineer: Architecture -> Backend/Frontend Overview -> Deployment Overview -> Pattern Catalog.
  • Backend maintainer: Backend pages -> Jobs/Cron/Reports -> Deployment runbooks.
  • Frontend maintainer: Frontend pages -> Routing/Auth -> State/Data -> Map flows.
  • Ops maintainer: Deployment pages -> Runbooks -> CI/CD workflow references.

How To Navigate Depth

  • If you only need high-level orientation, read only Public Summary sections.
  • If you need implementation behavior, read Internal Details and Source Anchors.
  • If you are making changes, review Risks and Trade-offs before editing code.

Student Obrok engineering documentation.