How suitenumerique/docs works
La Suite Docs is a collaborative document editor combining structured writing, organization, sharing, search, offline work, conversion, and optional AI. The main user flow is browser access and authentication, then document and hierarchy interaction through the Django API, with the Yjs provider maintaining live shared state and the backend supporting permissions and persistence. Additional branches cover imports/exports, AI, interoperability, and observability. The tree and README establish product scope; edges are limited to explicitly documented or excerpted relationships, so unsampled subsystems are represented without inferred call chains.
Main entry points: index.tsx Docs interface · viewsets.py Document API · yhub_services.py YHub client · fetchApi.ts Frontend API
Components 20
Web editor
- Docs interface
src/frontend/apps/impress/src/pages/index.tsx - Authentication
src/frontend/apps/impress/src/features/auth/hooks/useAuth.tsx - Frontend API
src/frontend/apps/impress/src/api/fetchApi.ts - Offline sync
src/frontend/apps/impress/src/features/service-worker/SyncManager.ts
Django application
- Documents and access
src/backend/core/models.py - Document API
src/backend/core/api/viewsets.py - Resource API
src/backend/core/external_api/viewsets.py - Search indexing
src/backend/core/tasks/search.py - JWT services
src/backend/core/services/jwt_services.py - Metrics
src/backend/core/metrics.py
Live collaboration
- YHub client
src/backend/core/services/yhub_services.py - Yjs collaboration
src/yhub-server/src/server.ts - Legacy migration
src/yhub-server/src/migration.ts
Document extensions
- Format conversion
src/backend/core/services/converter_services.py - AI writing
src/backend/core/services/ai_services/blocknote.py - Conversion provider
src/frontend/servers/y-provider/src/handlers/convertHandler.ts
Other components
- Editor
- AI provider
- DocSpec service
- S3 document storage
Connections 18
- Editor → Docs interface: uses
README.md - Docs interface → Authentication: checks session
src/frontend/apps/impress/src/features/auth/hooks/useAuth.tsx - Authentication → Frontend API: requests user
- Docs interface → Frontend API: calls API
- Docs interface → Offline sync: edits offline
README.md - Frontend API → Document API: HTTP requests
- Document API → Documents and access: reads and writes
- Document API → YHub client: collaboration actions
- YHub client → Yjs collaboration: REST calls
src/backend/core/services/yhub_services.py - Yjs collaboration → Legacy migration: migrates on startup
src/yhub-server/src/server.ts - Legacy migration → S3 document storage: reads versions
src/yhub-server/src/migration.ts - YHub client → JWT services: signs tokens
src/backend/core/services/yhub_services.py - Format conversion → DocSpec service: converts DOCX
src/backend/core/services/converter_services.py - Format conversion → Conversion provider: converts Yjs
src/backend/core/services/converter_services.py - AI writing → AI provider: requests models
- Resource API → Editor: serves integrations
README.md - Documents and access → Search indexing: indexes changes
src/backend/core/signals.py - Metrics → Yjs collaboration: observes collaboration