winzik/docs/ide/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.7 KiB

This documentation

The IDE carries its documentation with it: it works offline, in the exported executable as in the IDE run from its sources.

The Doc browser

Open it

  • the Doc button at the top right of the IDE;
  • Help > Documentation;
  • Search Everywhere (Double Shift) or Find Action (Ctrl+Shift+A): "Documentation";
  • the ? in the header of a tool window: that window's page.

Read

  • Left, the table of contents, grouped (Editing, Languages, Run, Web sites…). Pages marked soon describe features being built.
  • Right, the page: pictures, code, tables. Links to other pages open them here, links to the web open your browser.
  • ← / → (or Alt+← / Alt+→): the pages seen before and after.
  • Open in the browser: the same page on jumphp.net.

Type in the search box: every page that has all the words, the best first (a word of the title counts most), with the text around the first one. Accents and case are ignored; "two words" looks for them together. Enter opens the first result, Escape clears the search.

Searching the documentation

Language

The pages follow the IDE's language (Settings > Language). A page not translated yet shows in English, with a note.

Write the documentation

The pages are the Markdown files of docs/ide/ in JumPHP's repository (English), translations in docs/ide/<language>/, pictures in docs/ide/images/, the table of contents in docs/ide/toc.json. node --test ide/ui/js/docs-model.test.mjs checks that every page of the table exists and every link and picture leads somewhere. The IDE's build copies the folder into the IDE (ui/docs).