lx-annotate Documentation¶
Welcome to the developer and maintainer documentation for lx-annotate. These pages
cover data modeling conventions, implementation details, and automation workflows
used throughout the project.
Contents¶
Guides
- General Documentation Guide
- Deployment Strategy
- Overview
- Preferred Production Path
- Build Strategy
- Runtime Strategy
- Storage Recommendations
- Service Topology
- Ingress Contract
- Hub Export Contract
- Current Service Environment
- LuxNix Audit Findings
- Runtime Schema Gate And Feature-Tracker Alignment
- Data Recovery Unit
- Reverse Proxy Strategy
- LuxNix Strategy
- Current Limits
- Related Guides
- Runtime environment migration and rollback record
- Encrypted Storage Process
- Secure Backup and Disaster Recovery
- Current Recovery Status
- Security Invariants
- Recovery Classes
- Roles and Authorization
- Phase 1: Preserve and Inspect
- Phase 2: Non-Persistent Integrity Check
- Phase 3: Restore PostgreSQL into an Isolated Target
- Phase 4: Recover the Application Master-Key Boundary
- Phase 5: Restore Protected Media
- Phase 6: Reconcile and Approve
- Audit Record
- Cleanup, Rotation, and Retention
- Incident Escalation
- Readiness Gaps
- Hub Export Workflow
- Scope
- Core Decisions
- Marked For Upload
- Eligible Resources
- Sender State Machine
- Transfer Identity
- Transfer Mode Policy
- Retry And Reuse Rules
- Sender Payload Responsibilities
- Verified Hub Acknowledgement
- UI Workflow
- Operational Requirements
- Deployment And Operator Procedure
- Audit Requirements
- Local Cleanup Policy
- Summary
- Frontend Asset Deployment Contract
- Wheel Deployment
- PyPI Publishing
- AI Training Data Export
- Segment Annotation Workflow
- Anonymization Validation and Correction Workflow
- Dtypes Findings Migration (Incremental, Endoreg-Safe)
- Governed terminology delivery
- Core Concept Contract
- Core Concept Readiness Verdict
- Core Concept Type Matrix
- Reporting Template & Requirement Sets Page (TemplateRequirementsPage)
- Audience and Purpose
- Where This Page Is Used
- What You See on the Page
- Why Requirement Sets Matter (Clinical View)
- Typical Step-by-Step Workflow
- Full Reporting Flow (All Steps)
- Related Specialized Guides
- Quick Practical Path for Clinical Documentation
- Deep Link Behavior
- Field and Button Reference
- Developer Mapping: Requirement Objects to
lx_dtypesValidators - Common Problems and Practical Fixes
- Training Checklist (For Clinical Onboarding)
- Glossary (Plain Language)
- Related Technical Files (for Admins/Developers)
API Reference
Quick Links¶
Project repository: https://github.com/wg-lux/lx-annotate
Issue tracker: https://github.com/wg-lux/lx-annotate/issues
Shared type guidance: https://github.com/wg-lux/lx-data-models/tree/main/docs/guides