@@ -278,6 +278,53 @@ If rendering produces unexpected results, clear the generated directory:
278278rm -rf Documentation-GENERATED-temp/
279279```
280280
281+ ### Common Content Issues
282+
283+ #### RST Not Rendering / Changes Not Appearing
284+
285+ | Symptom | Cause | Fix |
286+ | ---------| -------| -----|
287+ | New page not in menu | Missing from ` toctree ` | Add to parent ` Index.rst ` toctree directive |
288+ | Page renders blank | Indentation error | Check 3-space indent for directive content |
289+ | Code block not highlighted | Missing language | Add language: ` .. code-block:: php ` |
290+ | Directive ignored | Missing blank line | Add blank line before and after directive |
291+
292+ #### Images Not Appearing
293+
294+ | Symptom | Cause | Fix |
295+ | ---------| -------| -----|
296+ | Broken image icon | Wrong path | Use ` /Images/... ` (absolute from Documentation root) |
297+ | Image missing in output | Not in Images folder | Move to ` Documentation/Images/ ` |
298+ | Alt text warning | Missing ` :alt: ` | Add ` :alt: Description ` to figure/image |
299+
300+ #### Cross-References Not Working
301+
302+ | Symptom | Cause | Fix |
303+ | ---------| -------| -----|
304+ | ` undefined label ` error | Label doesn't exist | Add ` .. _my-label: ` before target heading |
305+ | Wrong page linked | Duplicate labels | Use unique labels across all RST files |
306+ | Interlink fails | Missing inventory | Add to ` guides.xml ` interlink section |
307+
308+ #### Structure Issues
309+
310+ | Symptom | Cause | Fix |
311+ | ---------| -------| -----|
312+ | Directory not in menu | Missing Index.rst | Create ` Index.rst ` in every subdirectory |
313+ | Render fails immediately | Missing guides.xml | Run ` docker run ... init ` to scaffold |
314+ | Menu order wrong | toctree order | Reorder entries in toctree directive |
315+
316+ ### Debugging Render Failures
317+
318+ For verbose error output:
319+ ``` bash
320+ docker run --rm --pull always -v $( pwd) :/project -it \
321+ ghcr.io/typo3-documentation/render-guides:latest \
322+ --config=Documentation \
323+ --fail-on-log
324+ ```
325+
326+ Check the last few lines of output for specific RST file and line number causing the error.
327+
281328## CI/CD Integration
282329
283330For GitHub Actions, add documentation rendering to your workflow:
0 commit comments