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

Navigation

Search Everywhere

Double Shift (or the magnifier of the tool bar): one box for classes, files, symbols, actions and text. Tabs narrow it down: Classes (Ctrl+N), Files (Ctrl+Shift+N), Symbols (Ctrl+Alt+Shift+N), Actions (Ctrl+Shift+A), Text (the indexed search). file.php:42 opens at line 42.

Search Everywhere

Run Anything

Ctrl twice: type a bin/jumphp command; its commands and the project's games are completed, Enter runs it in the Run window.

Going to code

Shortcut
Ctrl+B / Ctrl+click go to the declaration
Ctrl+Alt+B implementations
Alt+F7 find usages (in the Find window)
Ctrl+Alt+H call hierarchy (the Calls window)
Ctrl+H type hierarchy (the Hierarchy window)
Ctrl+F12 file structure (a popup; the Structure window, Alt+7, keeps it open)
Ctrl+E recent files
Ctrl+Shift+E recently changed files: by their time on disk, whoever changed them (the IDE, Claude, git, a terminal), with a diff
Alt+F1 select the open file in the Project view
Ctrl+Alt+← / → back / forward

The Project view

Alt+1. The project's files; External Libraries (the engine, vendor/ packages, read only). Right click: new file / folder, rename, delete, copy path, Play, Run tests, open in the terminal, Show Local History. Follow keeps the open file selected. Files can be dragged to move them, and dropped from the file manager.