81 lines
1.5 KiB
Markdown
81 lines
1.5 KiB
Markdown
# Quickstart — 10 minutes (Proposer → Ticket → Apply → Tests)
|
||
|
||
## 1) Pré-requis
|
||
- Node.js + npm
|
||
- Accès Gitea (compte) + PAT si usage API (apply-ticket)
|
||
|
||
## 2) Lancer le site
|
||
en bash :
|
||
npm install
|
||
npm run dev
|
||
|
||
Dans le navigateur, url : http://localhost:4321
|
||
|
||
## 3) Proposer une correction
|
||
|
||
Ouvre une page (ex: Prologue).
|
||
|
||
Sur un paragraphe : clique Proposer.
|
||
|
||
Choisis :
|
||
|
||
Type : Correction / Fact-check
|
||
|
||
Category (optionnel)
|
||
|
||
Un nouvel onglet Gitea s’ouvre sur une issue pré-remplie.
|
||
|
||
Rédige :
|
||
|
||
Proposition (remplacer par):
|
||
|
||
Justification:
|
||
|
||
## 4) Appliquer le ticket en local (<NUMERO> = numéro du ticket non pas id-paragraphe)
|
||
|
||
En bash :
|
||
|
||
# dry-run (recommandé)
|
||
node scripts/apply-ticket.mjs <NUMERO> --dry-run
|
||
|
||
# appliquer
|
||
node scripts/apply-ticket.mjs <NUMERO>
|
||
git diff
|
||
git add <fichier>
|
||
git commit -m "edit: apply ticket #<NUMERO> (...)"
|
||
|
||
## 5) Vérifier avant push
|
||
|
||
npm test
|
||
|
||
## 6) Règle d’or
|
||
|
||
Ne jamais éditer dist/ à la main.
|
||
|
||
Toujours garder Chemin + Ancre + Proposition dans le ticket.
|
||
|
||
Déplacer/ajouter les deux docs que je t’ai donnés
|
||
- `docs/MANUEL_REFERENCE.md`
|
||
- `docs/CONTRAT_TICKETS.md`
|
||
|
||
*(Tu peux reprendre mes versions telles quelles.)*
|
||
|
||
---
|
||
|
||
## Commandes terminal P0 (copier-coller)
|
||
En bash
|
||
mkdir -p docs
|
||
|
||
# crée/édite les fichiers avec ton éditeur habituel
|
||
# README.md
|
||
# docs/QUICKSTART.md
|
||
# docs/MANUEL_REFERENCE.md
|
||
# docs/CONTRAT_TICKETS.md
|
||
|
||
git status -sb
|
||
npm test
|
||
git add docs/QUICKSTART.md docs/MANUEL_REFERENCE.md docs/CONTRAT_TICKETS.md
|
||
git commit -m "docs: add quickstart + reference manual + ticket contract"
|
||
git push
|
||
|