winzik/docs/ide/fr/docs-browser.md
David Nurdin 7de153fc14 IDE documentation: one page per feature (docs/ide/, French in docs/ide/fr/) and a Doc browser inside the IDE
- docs/ide/: 49 user pages grouped in toc.json (editing, languages, run / test / debug, Git, web sites and Symfony, databases,
  Docker and SSH, games, AI, team, settings); pages of features still being built are "coming soon" stubs with a TODO list;
  15 pages translated into French; docs/ide.md and docs/ide.fr.md link to them.
- The Doc button at the top right of the IDE, Help > Documentation, Search Everywhere "Documentation" and a "?" in each tool
  window's header open the Doc browser (ide/ui/js/docs-browser.js): table of contents, rendered pages (pictures, code, tables,
  links between pages and to headings), full-text search, back / forward, the IDE's language with English as the fallback.
- ide/src/Docs/DocsLibrary.php (docs.index, docs.image): reads only the documentation folder (strict names, real path checked);
  the packaged copy ui/docs first, else the repository's docs/ide.
- Packaging: tools/stage-game.sh copies docs/ide into the exported IDE (its *.md exclusion would drop them), overlay-build.php
  puts them in code updates, bin/jumphp ide syncs them.
- Tests: docs-model.test.mjs (TOC, links, anchors, pictures, search; every page and picture of docs/ide exists), DocsLibraryTest
  (path traversal refused), the i18n test covers the new texts in 14 languages.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
Claude-Session: https://claude.ai/code/session_01JkYTqsvYu6AYr9yQ3Q4Nt6
2026-11-16 00:08:42 +01:00

1.3 KiB

Cette documentation

L'IDE emporte sa documentation : elle marche hors ligne, dans l'exécutable comme dans l'IDE lancé depuis ses sources.

Le navigateur de documentation

L'ouvrir

  • le bouton Doc en haut à droite de l'IDE ;
  • Aide > Documentation ;
  • Search Everywhere (double Maj) ou Find Action : « Documentation » ;
  • le ? dans l'en-tête d'une fenêtre d'outil : la page de cette fenêtre.

Lire

  • À gauche, la table des matières, par groupes. Les pages marquées soon décrivent des fonctionnalités en cours.
  • À droite, la page : images, code, tableaux. Les liens vers d'autres pages les ouvrent ici, les liens web ouvrent votre navigateur.
  • ← / → (ou Alt+← / Alt+→) : les pages vues avant et après.
  • Ouvrir dans le navigateur : la même page sur jumphp.net.

Chercher

Tapez dans la zone de recherche : toutes les pages qui ont tous les mots, les meilleures d'abord, avec le texte autour. Accents et majuscules sont ignorés ; "deux mots" les cherche ensemble. Entrée ouvre le premier résultat, Échap efface.

Une recherche

Langue

Les pages suivent la langue de l'IDE (Réglages > Langue). Une page pas encore traduite s'affiche en anglais, avec une note.