Sensical Xtract Documentation¶
This site is the central documentation hub for the Sensical OBR platform.
What you will find here¶
- End-user workflows from project setup to measurement and reporting
- System architecture and integration details
- Existing project guides and API specification artifacts
- Operational notes for deployment, tests, and troubleshooting
Recommended reading path¶
- Start with User Manual > Introduction
- Continue through System Overview and UI Overview
- Use Project Management and Modeling sections for day-to-day operations
- Review Internals and API Specifications for implementation details
Platform at a glance¶
- Frontend: React app in berry-react/src
- Backend: Unified FastAPI application with REST, GraphQL, and legacy APIs
- Data: MongoDB with optional Redis cache
- Hardware integration: OBR wrapper proxy operations
Documentation maintenance¶
Keep this site aligned with code and operations.
- Update manual pages when workflows change
- Update internals pages when architecture or integrations evolve
- Refresh OpenAPI files when endpoint definitions change