Nicolas Cantu
ac96434351
**Motivations:** - Single canonical documentation tree under docs/; reduce drift between README copies. **Evolutions:** - Add docs/repo/ with operational guides (cron, systemd, projects, logs, docv, ia_dev, services, scripts, extension). - Replace scattered README.md files with pointers to docs/repo/*.md. - Refresh docs/README.md index and cross-links across docs/, .cursor rules/agents. - Bump ia_dev submodule to matching doc pointer commits.
39 lines
2.7 KiB
Markdown
39 lines
2.7 KiB
Markdown
# docv — intégration (`services/docv/`)
|
||
|
||
Ce répertoire ne contient **pas** le code du produit **docv** (gestion documentaire pour les projets Enso). Il documente le **contrat d’intégration** entre le monorepo **smart_ide** et le dépôt **docv**, attendu sous un chemin du type **`…/enso/docv`** sur la machine qui exécute docv.
|
||
|
||
## Documentation Enso (`services/docv/enso-docs/`)
|
||
|
||
Une **copie** de l’arborescence **`docs/`** du dépôt **enso** est conservée sous **`services/docv/enso-docs/`** pour consultation dans le monorepo **sans dépendre du clone enso** sur la machine. Mise à jour et périmètre : [docv-enso-docs-mirror.md](./docv-enso-docs-mirror.md).
|
||
|
||
## Rôle de docv
|
||
|
||
**docv** apporte les **services de gestion documentaire** aux projets : stockage, workflows et API métier documents côté filière Enso. Les **données projet** de référence vivent sur les **environnements déployés** ; docv (et les jobs de synchro AnythingLLM) les **récupèrent via SSH** — [features/remote-deployed-data-ssh.md](../features/remote-deployed-data-ssh.md).
|
||
|
||
## Convention de chemins : clones et zone de travail
|
||
|
||
| Concept | Description |
|
||
|---------|-------------|
|
||
| **`PROJECTS_CLONE_ROOT`** | Répertoire absolu parent des **clones** **`<projet>/`** (code). Souvent **`../projects`** relatif à **smart_ide** ([projects-directory.md](./projects-directory.md)). |
|
||
| **Données pour docv / RAG** | Répertoire résolu par **`DOCV_PROJECTS_ROOT`** (ou équivalent) : contenu **aligné sur les serveurs** test / pprod / prod après **pont SSH**, pas un dossier `data/` versionné dans Git. |
|
||
|
||
Sur un poste de développement, **`DOCV_PROJECTS_ROOT`** pointe typiquement vers un **cache ou miroir** alimenté par les scripts documentés dans le dépôt docv et [features/docv-service-integration.md](../features/docv-service-integration.md).
|
||
|
||
## Côté dépôt docv (amont)
|
||
|
||
Le code docv doit résoudre le chemin données via une variable d’environnement du type **`DOCV_PROJECTS_ROOT`**, puis :
|
||
|
||
`cheminDonnées = join(DOCV_PROJECTS_ROOT, projectId, 'data')`
|
||
|
||
sans chemins absolus figés dans le code. Détail : [features/docv-service-integration.md](../features/docv-service-integration.md).
|
||
|
||
## Consommateurs smart_ide (orchestrateur, front)
|
||
|
||
Variables documentées dans `services/docv/.env.example`. Valeurs réelles **hors dépôt** ([platform-target.md](../platform-target.md)).
|
||
|
||
## Liens
|
||
|
||
- Gestion documentaire + données + multi-hôte : [features/docv-service-integration.md](../features/docv-service-integration.md)
|
||
- API IA consommées par docv : [features/docv-ai-integration.md](../features/docv-ai-integration.md)
|
||
- SSO OIDC : [features/sso-docv-enso.md](../features/sso-docv-enso.md)
|