Use this guide to understand how Sambee is built across the backend, frontend, and companion, work safely in the repository and choose the right contributor workflow, understand the architecture and cross-cutting systems before changing code, and validate changes with the right checks before review or release.
Start Here if You Want To
- Understand how the browser app, backend, and companion fit together.
- Find the right place in the repository before changing code.
- Set up the development environment and use the common contributor workflows.
- Understand the high-level architecture of the backend, frontend, and companion.
- Understand deeper contributor rules for preview pipelines, companion trust, or version-sensitive changes.
- Choose the right validation commands before you open a pull request.
In This Guide
- Project Orientation : Understand the product boundaries and the repository layout.
- Local Development Workflow : Set up the environment and find the commands you will actually use.
- Backend Architecture : Understand the FastAPI service, SMB-facing behavior, and server-side contracts.
- Frontend Architecture : Understand the browser app, page structure, and UI behavior contracts.
- Companion Architecture : Understand the desktop app, pairing model, local-drive access, and native-app editing workflow.
- Cross-Cutting Systems : Understand shared logging, localization, and other rules that span more than one app.
- Testing and Quality Gates : Choose the right checks for the change you are making.
- Contribution Workflows : Plan and review changes with the right scope and validation depth.
- Security : Understand dependency automation, vulnerability scanning, and release-artifact integrity.
- Release and Versioning : Handle dependency updates and version metadata safely.
Use the Right Guide
- Use the Developer Guide when the next question is implementation-facing.
- Use the Website Dev Guide when the work is on the public website, published docs content, docs tooling, or shared website theme systems.
- Use the User Guide when the next step belongs to the person using Sambee in normal workflows.
- Use the Admin Guide when the next step is deployment, configuration, operations, or escalation.