Skip to content

fix: Corriger les accents manquants dans la documentation#129

Merged
nedseb merged 7 commits intomainfrom
fix/missing-accents
Apr 1, 2026
Merged

fix: Corriger les accents manquants dans la documentation#129
nedseb merged 7 commits intomainfrom
fix/missing-accents

Conversation

@nedseb
Copy link
Copy Markdown
Contributor

@nedseb nedseb commented Apr 1, 2026

Summary

Correction des accents manquants

  • Audit systématique et correction de ~250 mots français sans accents dans 55+ fichiers Markdown
  • Sections touchées : design/, hardware/, overview/, components/, pin-mapping/
  • Contenu principalement issu de la migration Notion
  • Les URLs, noms de fichiers (Altium SchDoc, images) et blocs de code non modifiés

Intégration de cspell (vérification orthographique)

  • Installe cspell (9.7.0) + @cspell/dict-fr-fr (2.3.2) avec versions épinglées
  • Configure cspell.json avec dictionnaire français et dictionnaire custom .cspell/steami.txt (~150 termes techniques)
  • Ajoute flagWords pour bloquer les erreurs d accent récurrentes
  • Intègre dans lint-staged : prettier --check + markdownlint + cspell sur les *.md
  • Ajoute le step "Spell check" dans le workflow CI build
  • Ajoute le script npm lint:spell
  • Relève engines.node à >=20.18.0 (requis par cspell)

Exemples de corrections

developpement → développement, memoire → mémoire, microcontroleur → microcontrôleur, systeme → système, ecran → écran, schema → schéma, serie → série, accelerometre → accéléromètre, magnetometre → magnétomètre, temperature → température, humidite → humidité, Caracteristiques → Caractéristiques, regulateur → régulateur

Test plan

  • Build Docusaurus passe sans erreur
  • npm run lint:spell — 0 erreur sur 73 fichiers
  • Pre-commit lint-staged valide cspell + prettier + markdownlint sur les .md
  • Vérification grep : aucun mot français courant sans accent restant
  • CI build passe

Closes #128, closes #130

Audit systématique et correction de ~200 mots français sans accents
dans 51 fichiers Markdown, principalement dans les sections design/,
hardware/ et overview/ migrées depuis Notion.

Corrections principales : développement, mémoire, périphérique,
microcontrôleur, système, écran, température, accéléromètre,
magnétomètre, schéma, caractéristiques, électronique, etc.

Les URLs, noms de fichiers Altium et blocs de code n'ont pas été modifiés.

Closes #128
Copilot AI review requested due to automatic review settings April 1, 2026 14:41
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Cette pull request corrige des accents manquants dans la documentation (Markdown) afin d’améliorer la lisibilité et la qualité éditoriale des pages, principalement issues d’une migration depuis Notion.

Changes:

  • Correction systématique de mots français sans accents (titres, paragraphes, tableaux).
  • Harmonisation de libellés récurrents (ex. « Schéma(s) », « Microcontrôleur », « Écran », « Mémoire », etc.) dans les sections overview/design/hardware.
  • Mise à jour de textes d’UI/lexique technique dans la doc sans toucher aux URLs, chemins, ni blocs de code.

Reviewed changes

Copilot reviewed 51 out of 51 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
docs/overview/index.md Corrections d’accents sur la page d’introduction et ses sections (caractéristiques, architecture, liens).
docs/hardware/schematic.md Corrections d’accents sur la page des schémas et tableaux associés.
docs/hardware/pin-mapping/test-points.md Corrections d’accents sur descriptions et titres (points de test).
docs/hardware/pin-mapping/signals.md Corrections d’accents dans la table des signaux et descriptions.
docs/hardware/pin-mapping/power-pins.md Corrections d’accents dans la table des rails d’alimentation.
docs/hardware/pin-mapping/leds.md Corrections d’accents dans la description et tableaux LEDs.
docs/hardware/pin-mapping/internal-bus.md Corrections d’accents dans la section bus internes (I2C/SPI).
docs/hardware/pin-mapping/index.md Corrections d’accents dans l’index “Pin Mapping” et son sommaire.
docs/hardware/pin-mapping/external-connectors.md Corrections d’accents sur un titre de connecteur.
docs/hardware/pin-mapping/edge-connector.md Corrections d’accents sur descriptions et titres de sections.
docs/hardware/pin-mapping/buttons.md Corrections d’accents sur descriptions, titres, et libellés de tableaux.
docs/hardware/main-components/w25q64.md Corrections d’accents sur la page mémoire flash externe et sections “Schémas”.
docs/hardware/main-components/stm32wb55.md Corrections d’accents sur la page du MCU applicatif et ses sections.
docs/hardware/main-components/stm32f103.md Corrections d’accents sur la page du MCU interface (USB/I2C/sections).
docs/hardware/main-components/sensors/wsen-pads.md Corrections d’accents sur la page capteur pression (caractéristiques/schémas).
docs/hardware/main-components/sensors/wsen-hids.md Corrections d’accents sur la page capteur humidité/température.
docs/hardware/main-components/sensors/vl53l1x.md Corrections d’accents sur la page capteur distance.
docs/hardware/main-components/sensors/lis2mdl.md Corrections d’accents sur la page magnétomètre + liens “Voir aussi”.
docs/hardware/main-components/sensors/ism330dlc.md Corrections d’accents sur la page accéléromètre/gyroscope + liens.
docs/hardware/main-components/sensors/index.md Corrections d’accents dans la page d’index des capteurs (table + sections).
docs/hardware/main-components/sensors/imp34dt05.md Corrections d’accents sur la page microphone (caractéristiques/schémas).
docs/hardware/main-components/sensors/apds9960.md Corrections d’accents sur la page capteur lumière/couleur/geste.
docs/hardware/main-components/power/index.md Corrections d’accents sur la page alimentation (tables + titres).
docs/hardware/main-components/power/bq27441.md Corrections d’accents sur la page jauge de batterie.
docs/hardware/main-components/power/bq24075.md Corrections d’accents sur la page chargeur de batterie.
docs/hardware/main-components/leds.md Corrections d’accents sur la page LEDs (descriptions + tables).
docs/hardware/main-components/index.md Corrections d’accents sur l’index des composants principaux.
docs/hardware/main-components/display.md Corrections d’accents sur la page écran OLED (titre + sections).
docs/hardware/main-components/connectors/swd.md Corrections d’accents sur la page port SWD (débogage/schémas).
docs/hardware/main-components/connectors/stemma-qwiic.md Corrections d’accents sur la page STEMMA/Qwiic.
docs/hardware/main-components/connectors/jacdac.md Corrections d’accents sur la page Jacdac (série/caractéristiques).
docs/hardware/main-components/connectors/index.md Corrections d’accents sur l’index des connecteurs (table + schémas).
docs/hardware/main-components/connectors/edge-connector.md Corrections d’accents sur la page connecteur edge (accès, fonctionnalités).
docs/hardware/main-components/connectors/crocodile-pads.md Corrections d’accents sur la page pads crocodile (tables + texte).
docs/hardware/main-components/buttons-audio.md Corrections d’accents sur boutons/buzzer (sections + schémas).
docs/hardware/index.md Corrections d’accents sur la page overview hardware (titres, tables, légendes).
docs/hardware/components/not-fitted.md Corrections d’accents sur la page DNP (titres + notes).
docs/hardware/components/integrated-circuits.md Corrections d’accents sur la page “Circuits intégrés” (titres + lignes).
docs/hardware/components/index.md Corrections d’accents sur libellés dans l’index composants.
docs/hardware/components/display-audio.md Corrections d’accents sur la page “Écran et audio” (titres/sections).
docs/hardware/components/crystals.md Correction d’accents sur une mention “microcontrôleur interface”.
docs/hardware/components/connectors.md Corrections d’accents sur page connecteurs (texte + sections).
docs/hardware/components/battery.md Corrections d’accents sur page batterie (caractéristiques/gestion).
docs/design/user-interface.md Corrections d’accents sur exigences et choix de conception (UI).
docs/design/service-usb.md Corrections d’accents sur exigences service/USB et sections associées.
docs/design/sensors.md Corrections d’accents sur exigences capteurs et choix de conception.
docs/design/power.md Corrections d’accents sur exigences alimentation et sections explicatives.
docs/design/mcu-storage.md Corrections d’accents sur exigences MCU/stockage et description bus.
docs/design/index.md Corrections d’accents sur tableau récapitulatif des domaines et liens.
docs/design/constraints.md Corrections d’accents sur contraintes et sections (température/durée/etc.).
docs/design/communication.md Corrections d’accents sur exigences communication/stockage et descriptions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

# Composants principaux

Les composants actifs de la carte STeaMi, regroupes par fonction. Chaque composant dispose d'une page detaillee avec specifications completes, pinout, liens datasheets et drivers.
Les composants actifs de la carte STeaMi, regroupés par fonction. Chaque composant dispose d'une page détaillée avec specifications complètes, pinout, liens datasheets et drivers.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dans cette phrase, « specifications » est un mot français qui devrait être accentué (« spécifications ») pour rester cohérent avec l’objectif de correction des accents et avec le reste des termes déjà accentués (ex. « détaillée », « complètes »).

Suggested change
Les composants actifs de la carte STeaMi, regroupés par fonction. Chaque composant dispose d'une page détaillée avec specifications complètes, pinout, liens datasheets et drivers.
Les composants actifs de la carte STeaMi, regroupés par fonction. Chaque composant dispose d'une page détaillée avec spécifications complètes, pinout, liens datasheets et drivers.

Copilot uses AI. Check for mistakes.
nedseb added 6 commits April 1, 2026 16:47
Adresse le commentaire Copilot sur la PR #129.
Corrections additionnelles trouvées par vérification croisée :
- specifications → spécifications, complete → complète
- categorie → catégorie, references → références
- resistances → résistances, boitier → boîtier
- general → général, presente → présente
- Donnees → Données
- Installe cspell + @cspell/dict-fr-fr
- Configure cspell.json avec dictionnaires fr-fr et termes techniques
- Crée .cspell/steami.txt avec ~150 termes spécifiques au projet
- Ajoute flagWords pour les erreurs d'accent les plus courantes
- Intègre dans lint-staged (pre-commit sur *.md)
- Ajoute le step "Spell check" dans le workflow CI build
- Ajoute le script npm lint:spell
- Corrige les derniers accents manquants détectés par cspell

Closes #130
Évite les erreurs de formatage sur les .md qui passaient inaperçues
au pre-commit et cassaient le CI.
- Épingler les versions cspell (9.7.0) et @cspell/dict-fr-fr (2.3.2)
- Relever engines.node à >=20.18.0 (requis par cspell)
- Simplifier lint:spell pour utiliser la config cspell.json (inclut CONTRIBUTING.md)
- Ajouter "wurth" au dictionnaire custom
@nedseb nedseb merged commit 25d0ace into main Apr 1, 2026
1 check passed
nedseb added a commit that referenced this pull request Apr 1, 2026
Adresse le commentaire Copilot sur la PR #129.
@nedseb nedseb deleted the fix/missing-accents branch April 1, 2026 16:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

ci: Ajouter cspell pour la vérification orthographique fix: Corriger les accents manquants dans la documentation

2 participants