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

34 lines
2.1 KiB
Markdown

# YAML and Docker Compose
Every `.yaml` / `.yml` file is read as YAML.
## Editing
- **Colours**: keys, anchors / aliases / `<<`, tags (`!php/const`, `!tagged_iterator`), block scalars, `${VAR:-default}`.
- **Problems as you type**: syntax errors with line and column; in Compose files unknown keys, a service without image nor build,
ports / volumes / environment / restart written wrong, `depends_on` / networks / named volumes nobody declares; Symfony's
`config/services.yaml` keys.
- **Completion**: Compose keys and values, ready-made services under `services:`, `image:` names and tags from Docker Hub,
Symfony's service keys, JumPHP's `config/*.yaml`.
- **Hover** on `image:`: Docker Hub's description, stars and pulls.
- Folding, and the outline in **Structure** (`Ctrl+F12`).
## Navigation
`Ctrl+click` / `F12` goes to the definition, `Shift+F12` / `Alt+F7` lists the usages, hover shows the definition, `Shift+F6`
renames. Values that lead to one file are links.
| In | Leads to |
|---|---|
| YAML itself | alias `*x` → anchor `&x`; the hover of `<<: *x` shows the merged keys |
| Symfony `config/` | `imports` / `resource` → files; a class or `controller: X::method` → the code; `@service` → its definition; `%parameter%` → `parameters:`; `%env(X)%` → the `.env` lines; `!tagged_iterator` → the tagged services; `!php/const` → the constant |
| translations | `translations/*.yaml` keys ↔ `'key'\|trans` in Twig and `->trans('key')` in PHP |
| Compose | `extends`, `env_file`, `build`, host paths, `configs` / `secrets`, `depends_on` / `networks` / volumes ↔ their declarations |
| JumPHP | `start_scene` → the class, asset paths → files, `input.yaml` actions ↔ `isPressed('…')`, `lang.yaml` keys ↔ `Lang::t('…')`, form events → methods |
From PHP or Twig, `Ctrl+click` on such a string opens its YAML.
## Docker Compose in the Docker window
**Docker > Compose**: the project's compose files per folder, create the override, **Add a service** (templates), **Check**
(`docker compose config`, errors in Problems), **Apply**. See [Docker](docker.md).