docs: restructure FAQ into topic-based pages#1898
Open
neilsh wants to merge 4 commits intoOnionUI:mainfrom
Open
docs: restructure FAQ into topic-based pages#1898neilsh wants to merge 4 commits intoOnionUI:mainfrom
neilsh wants to merge 4 commits intoOnionUI:mainfrom
Conversation
Prepare for FAQ split by copying the original file to each topic-specific file. This preserves git blame history when the content is trimmed in the next commit.
Restructure the monolithic 700-line FAQ into 5 focused sub-pages: - 01-organizing-games: Box art, manuals, cheats, multi-disk - 02-troubleshooting: Boot loops, games not launching, Wi-Fi - 03-saves: Save states, auto-load, state slots - 04-emulator-settings: Scaling, RetroArch, remapping, RTC - 05-various: CFW explanation, overclocking Convert index.mdx to navigation hub using DocCardList. Each page uses DynamicFAQSection for hash-based deep linking. This improves: - SEO (each topic is directly searchable) - Direct linking to specific FAQ sections - Maintainability (smaller, focused files) - Page load performance
Skip FAQ restructure commits from git blame output. Configure with: git config blame.ignoreRevsFile .git-blame-ignore-revs
Relative links resolve within the FAQ subdirectory, so emulators links need absolute /docs/emulators paths.
tGecko
approved these changes
Jan 31, 2026
Member
tGecko
left a comment
tGecko
left a comment
There was a problem hiding this comment.
There is an issue with links, but it is not due to this PR. We're investigating
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
2 participants
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
Split the monolithic 700-line FAQ into 5 focused topic pages for improved readability and maintainability.
Changes
New Structure
Key Details
DocCardList(same pattern as dev docs)DynamicFAQSectionfor hash-based deep linking/docs/emulatorspathsGit Blame Preservation
Added
.git-blame-ignore-revsto skip restructure commits from blame. The refactor used a copy-then-edit approach:index.mdxto each topic fileTesting
npm run buildpasses with no broken links