~/talk

"Switch your extension’s documentation to the new PHP-based rendering"

Talkat TYPO3 Developer Days 2024 · 2024-08-01..08-03· [documentation, php]
links:none on file
name:Lina Wolf
links:none on file
slides:none on file

Claims a full TYPO3 changelog of several thousand pages now renders in 5 minutes for thousands of pages versus 30–60 minutes with the old Sphinx/Python renderer, and small docs hit about 56 seconds on the GitHub workflow. Uses a PHP-based renderer with Docker/Podman and optional GitHub Actions, a migration tool that converts settings.cfg to guides.xml, and automatic linting of PHP code snippets. New features include a hover popup that generates inter-manual composer links and PHP FQN linking to api.typo3.org with IDE-like info and GitHub line anchors; a live demo migrates an extension and produces seven rendered HTML files successfully.

AI-written summary · about

  1. 0:00Introduction to new rendering
  2. 1:53Faster rendering and live updates
  3. 3:47Improved linking features
  4. 5:53Class name linking and IDE integration
  5. 7:38Migration steps and timeline
  6. 9:47Automatic testing and search options
  7. 11:42File handling and code snippets
  8. 14:12Live demo begins
  9. 20:40Cleaning up old files
  10. 25:51Setting composer name
  11. 31:17GitHub Actions setup
  12. 33:29Makefile for local rendering
  13. 37:05Q&A on documentation inclusion
  14. 39:00Q&A on templates and tools
  15. 41:19Q&A on generation commands
  16. 43:04Future projects and closing
~/search
type to search 6,249 conferences, 138,987 speakers and 185,172 talks
~/help
cmdctrl k
search every conference, speaker and series
/
focus the filter search
h
home
c
conferences
s
speakers
e
series
t
light / dark — the status bar button does the same
?
this help
esc
close this, then clear every filter — or just the search, while you are typing in it

Ignored while you are typing. Pages without a filter rail have no search to focus.