36 lines
4.4 KiB
Markdown
36 lines
4.4 KiB
Markdown
# Documentation LeCoffre.io (index)
|
||
|
||
**Projet ia_dev** : **kogus** (orchestration de ce monorepo). Le site notaire en production reste **`lecoffreio`** (FQDN `*.lecoffreio.*`, unités systemd `lecoffreio-*`, `sites.code` en base).
|
||
**Wiki (miroir optionnel)** : https://git.4nkweb.com/4nk/kogus/wiki
|
||
**Correspondance fichier → page wiki** : nom du fichier sans `.md`, `_` → `-`, title-case par segment (ex. `README.md` → Readme, `Operations.md` → Operations).
|
||
|
||
## Statut de cette documentation
|
||
|
||
- **Référence canonique** : dans ce monorepo, **`docs/` est versionné** et sert de documentation technique de référence (ainsi que `docs/features/` pour les fiches ciblées).
|
||
- **Miroir wiki** : si le projet maintient un miroir sur le wiki Gitea, il est alimenté à partir de ces fichiers (voir § *Mise à jour du wiki*).
|
||
- **Numéro de version publié** : fichier **`VERSION`** à la racine du monorepo, **`front-common/src/front/version.json`** (`"version": "v"` + valeur exacte de **`VERSION`**), et entrées **`CHANGELOG.md`**. Incrément patch : depuis la racine **`IADEV_REPO`**, **`./deploy/pousse.sh kogus --bump-version`** (build `build_dirs` puis commit/push sur la branche courante du dépôt applicatif ; message multi-lignes sur stdin, voir **`IADEV_REPO/.smartIde/agents/push-by-script.md`**).
|
||
|
||
## Pages disponibles (docs/ racine)
|
||
|
||
| Fichier | Page wiki | Description |
|
||
|---------|-----------|-------------|
|
||
| README.md | Readme | Index et correspondance (ce fichier). |
|
||
| API.md | Api | APIs externes (IdNot, Annuaire, Ancrage, agent IA notaire), contrats et évolution. |
|
||
| Operations.md | Operations | Retours prod, parcours, vérifications, scripts d’analyse, modalités d’analyse. |
|
||
| Frontend.md | Frontend | Toasters, messages 403, sources de textes front, paramétrage, parcours UI. |
|
||
| Code-Standards.md | Code-Standards | Lint, refactors, rôles et droits, conventions. |
|
||
| Deployment.md | Deployment | Env, seeds, site-texts, vérifications boot, déploiement. |
|
||
| `scripts/verify-site-texts-thirdparty-scope-readonly.sh` | Ops | Lecture seule : scopes `site_texts` pour clés `thirdParty.%` via SSH sur la cible (voir Deployment.md §3.1). |
|
||
| Architecture.md | Architecture | Vue d’ensemble technique et intégrations. |
|
||
| compliance-annuaire-idnot-specs.md | Compliance-Annuaire-Idnot-Specs | Conformité API Annuaire V2 et ID.NOT (lookup, PP). |
|
||
|
||
Contenu des anciens dossiers `docs/features/` et `docs/fixKnowledge/` : en grande partie ventilé dans les pages ci-dessus ; certaines **fiches techniques** restent sous `docs/features/` (ex. notaire office actif / IdNot : `notary-active-office-idnot-subscriptions.md`, liée depuis `Architecture.md` ; **structure login / email / helpers** après refactors ESLint : `login-and-email-helpers-structure.md`, liée depuis `Architecture.md` et `Frontend.md` ; **IA dossier notaire** (workflow, spooler ia_dev, emplacements des composants) : `notary-folder-ai-workflow.md`, liée depuis `API.md` ; **stockage fichiers chiffrés / rétrocompat IPFS** : `local-encrypted-file-storage.md`, liée depuis `Architecture.md` ; **archivage long dossier** : `long-term-folder-archive.md`, liée depuis `local-encrypted-file-storage.md` et `Architecture.md`). **Multi-site** : runbook opérateur `features/multi-site-deploy-runbook.md` (ordre test → pprod/prod, migrate, déploiement) ; architecture `features/multi-site-architecture.md` ; secrets disque **`lecoffreio` / `kogus` / `enso` / `genealogie`** : `features/secrets-multisite-kogus-and-sites.md` ; inventaire SQL `features/multi-site-sql-site-code-inventory.md` ; courriel `features/multi-site-mail-transactional-coverage.md` ; Stripe `features/multi-site-stripe-billing-edge.md`.
|
||
|
||
## Mise à jour du wiki
|
||
|
||
Depuis la racine de ce dépôt (qui contient `docs/`) :
|
||
|
||
- **Préparer / synchroniser** : mettre à jour les fichiers `docs/*.md` et, si nécessaire, `docs/features/*.md` (ces derniers peuvent être référencés depuis les pages wiki, sans duplication de contenu).
|
||
- **Pousser vers le wiki (si activé)** : utiliser le script `IADEV_REPO/git-issues/wiki-migrate-docs.sh`. Détails (correspondance fichier → page, conventions, périmètre) : `IADEV_REPO/projects/ia_dev/docs/GIT_ISSUES_SCRIPTS_AGENTS.md` (section *Migration docs/ → wiki*).
|
||
- **Changement de slug Gitea ou de chemin du clone local** : `docs/operations/gitea-repo-and-local-path-rename.md` (wiki, tickets, CI, remotes, chemins ia_dev et agents).
|