winzik/docs/ide/help-and-updates.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

21 lines
1.1 KiB
Markdown

# Help, logs and updates
## Help menu
**Documentation** (this), **Keyboard Shortcuts**, **JumPHP Documentation** (jumphp.net/docs), **Show Logs**, **What's New…**,
**Check for Updates…**, **Update Automatically**, **About**.
## Logs
**View > Logs** (`Alt+F11`): what the IDE does and fails at, and every program it runs (`bin/jumphp`, Docker, git, Claude…: the
command, how it ended, the end of its errors), with a level, a source, a text search, **Pause**, Copy and Clear. An error while the
window is closed puts a red mark on its button. The same lines go to `<IDE data folder>/logs/ide.log`: the folder button copies its
path, to join to a bug report.
## Updates
The installed IDE checks for updates 8 s after it starts and every 6 hours. Most updates are **code updates** (about 0.5 MB, signed,
taken at the next start); some are full releases (a new executable, downloaded and checked in the background). A notification offers
**Restart Now**; the **Update** button of the tool bar does it at once. A code update that makes the IDE crash is dropped by itself.
**What's New** shows the news of a new version once, in your language.