docs: add main menu guide and nest the mystery gift series#37
Open
Zodiarche wants to merge 2 commits into
Open
docs: add main menu guide and nest the mystery gift series#37Zodiarche wants to merge 2 commits into
Zodiarche wants to merge 2 commits into
Conversation
Zodiarche
changed the title
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
1 participant
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.
Summary
Adds a Main Menu customization guide to the UI development section (EN + FR), migrated from
docs/MainMenu.mdin the engine repository. The page goes further than the original document: it explains the registration model (action + visibility condition), warns thatregister_buttonappends to the already-registered defaults instead of replacing them, covers the Quit icon/text fallback for new buttons, and uses theprependconvention from the monkey-patching guide in its examples.Second commit: nests the 11-step Mystery Gift series into its own sidebar category (
psdk/ui-development/mystery-gift/). Without this, any standalone guide added topsdk/ui-development(starting with this one) was picked up by the "Mystery Gift — Step X / Y" progress tracker, which keys onsourceDirName. The series now has its own category (collapsible in the sidebar, own generated index), the tracker gate targets the new directory, andui-developmentbecomes the home for standalone UI guides.Note: the 11 series pages change URL (
/psdk/ui-development/<slug>becomes/psdk/ui-development/mystery-gift/<slug>). Old shared links will 404; decision made to accept this rather than add a redirects plugin.Related issues
Closes #36
Test plan
bun run typecheckpasses.bun run buildpasses on both locales: validates all internal links, confirming nothing else pointed at the old series URLs.scripts/4 Systems/100 Menu/100 Menu.rband300 MenuButtonBase.rb)./psdk/ui-development/mystery-gift/prepare-ui-assets) and NOT on the new guide (/psdk/ui-development/customize-main-menu); sidebar shows the Mystery Gift group plus the standalone guide in both locales (bun run previewfor the FR pass).Screenshots
The page embeds the in-game Main Menu screenshot from the engine repository (
static/img/psdk/ui-development/main-menu.png).