docs: document the 5.4 release - #168
Merged
Merged
Conversation
New pages for notifications, email, the audit log, parental controls, library conversion, EasyRPG, devices, RetroArch Cloud Sync and upgrading, plus updates across install, administration, using and developer pages for the CORS and FORWARDED_ALLOW_IPS defaults, sync and socket changes. Regenerates the env var, scheduled task and platform snippets against rommapp/romm 9ae2cd0e1, and teaches gen_scheduled_tasks to read the TaskSpec entries the task registry now declares inline. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
gantoine
marked this pull request as ready for review
October 5, 2026 12:54
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- Correct converto startup exit, polling fallback, netplay visibility, CORS wildcard credentials, OIDC redirect scope, CHD sources, reset link hosts, curl filename and HMAC byte comparison - Generator: show disabled tasks as off, spell out comparison gates, fail on splat/positional TaskSpec args and duplicate specs - Restore SSH Sync link - Document kiosk browsing of roms/ over WebDAV and the full dev proxy path list - Drop the 401 challenge sentence from the RetroArch page Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…agraph Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs for the upcoming 5.4 release (5.4.0-alpha.1 changelog). Every page was checked against
rommapp/rommat9ae2cd0e1, the commit that ends at #5142.New pages
install/upgrading.md: general upgrade steps, then a 5.3 to 5.4 section with the three release warnings (migrations, CORS,FORWARDED_ALLOW_IPS), the Viewer/Editor rename and a table of breaking API changesusing/notifications.md: the inbox, channels (webhook with HMAC verification, email, Apprise) and the APIadministration/email.md:SMTP_*setup, and what email powersadministration/audit-log.md: what's recorded, who can read it, retention andGET /api/audit-eventsadministration/parental-controls.md: age limits, hiding unrated games, how a game's age is computed, with a rating mapping tableadministration/library-conversion.md: rom-converto, theconvertoconfig block, the Convert library task and?format=downloadsusing/in-browser-play/easyrpg.md: RPG Maker 2000/2003 in the browserusing/devices.md: browser profiles as devices, and installing games on a deviceecosystem/retroarch-cloud-sync.md: RetroArch Cloud Sync over WebDAVUpdated pages
POST /api/tasks/scan), OIDC and authentication troubleshooting, netplay, saves and states, downloads, users and roles, scheduled tasks, search, languages, jukebox, metadata providers, the configuration file, the glossary and the nav.Generators
sources.tomlis pinned to9ae2cd0e1because the5.4.0-alpha.1tag doesn't exist yet. Bump it to the tag before merging.gen_scheduled_tasks.pynow reads theTaskSpec(...)entries thatbackend/tasks/registry.pydeclares inline. The old import-based parser failed against the new registry.Where the docs differ from the changelog
The changelog doesn't match the source in a few places, and the docs follow the source:
FORWARDED_ALLOW_IPShad no effect before 5.4, because*was hard-coded.xiso. Only library formats are lossless-only.Checks
trunk checkis clean.mkdocs buildhas no link or anchor warnings.No screenshots yet. The changelog's screenshot placeholders weren't carried over.
🤖 Generated with Claude Code