Skip to content

Conversation

@neilsh
Copy link

@neilsh neilsh commented Jan 23, 2026

Summary

Split the monolithic 700-line FAQ into 5 focused topic pages for improved readability and maintainability.

Changes

New Structure

website/docs/03-faq/
├── index.mdx                  # Navigation hub with DocCardList
├── 01-organizing-games.mdx    # Box art, manuals, cheats, multi-disk
├── 02-troubleshooting.mdx     # Boot loops, games not launching, Wi-Fi
├── 03-saves.mdx               # Save states, auto-load, state slots
├── 04-emulator-settings.mdx   # Scaling, RetroArch, remapping, RTC
└── 05-various.mdx             # CFW explanation, overclocking

Key Details

  • Index page uses DocCardList (same pattern as dev docs)
  • Each page uses DynamicFAQSection for hash-based deep linking
  • Links fixed to use absolute /docs/emulators paths

Git Blame Preservation

Added .git-blame-ignore-revs to skip restructure commits from blame. The refactor used a copy-then-edit approach:

  1. First commit copies index.mdx to each topic file
  2. Second commit trims each file to relevant content

Testing

  • npm run build passes with no broken links
  • ✅ Visual verification in browser confirms all pages render correctly
  • ✅ Collapsible FAQ items work as expected

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 tGecko self-assigned this Jan 31, 2026
Copy link
Member

@tGecko tGecko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is an issue with links, but it is not due to this PR. We're investigating

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants