Documentation AD-Vision

Site de documentation utilisateur d’AD-Vision, logiciel de gestion de cabinet pour orthoptistes libéraux.

Publié sur docs.ad-vision.fr.

Stack

• VitePress 1.x
• Node.js 22 (CI)
• Thème personnalisé (accueil type vitrine, Font Awesome local, charte AD-Vision)

Prérequis

• Node.js 22+
• npm

Lancer en local

npm ci
npm run docs:dev

Le site est servi avec rechargement à chaud. En production, les URLs sont sans .html (cleanUrls).

Aperçu du build de production :

npm run docs:build
npm run docs:preview

Le build échoue si un lien interne est mort (ignoreDeadLinks: false).

Contenu

Dossier	Rôle
guides/	Parcours métier (premiers pas, facturation, télétransmission, Link, etc.)
reference/	Pages écran par écran (connexion, patients, facturation, cabinet, appareils…)
public/	Assets statiques (logos, images)
.vitepress/	Config, sidebar, thème, styles
deploy/	Exemple de vhost nginx pour docs.ad-vision.fr

La navigation est définie dans .vitepress/sidebar.ts. Toute nouvelle page doit y être ajoutée, sinon elle n’apparaît pas dans le menu.

Convention : messages utilisateur en français ; titres et slugs d’URL en français, kebab-case.

Ajouter une page

1. Créer un fichier Markdown, par exemple reference/patients/nouvelle-page.md.
2. Déclarer l’entrée dans .vitepress/sidebar.ts (lien du type /reference/patients/nouvelle-page).
3. Relancer docs:dev et vérifier que la page et les liens internes fonctionnent.

Frontmatter VitePress standard (title, description, etc.) si besoin.

Déploiement

Un push sur main déclenche .github/workflows/deploy-docs.yml :

1. npm ci puis npm run docs:build
2. Publication de l’artefact .vitepress/dist
3. rsync vers /var/www/advision-docs/dist/ sur le serveur HDS

Le secret GitHub DEPLOY_SSH_KEY est requis. Un lancement manuel est possible via workflow_dispatch.

Le vhost nginx de référence est dans deploy/nginx-docs.ad-vision.fr.conf.