mirror of
https://github.com/Polprzewodnikowy/N64FlashcartMenu.git
synced 2025-12-18 19:15:58 +01:00
177c2b5efd
<!--- Provide a general summary of your changes in the Title above -->
## Description
<!--- Describe your changes in detail -->
Improves documentation.
Moves to docfx for website publishing.
Splits devcontainers.
## Motivation and Context
<!--- What does this sample do? What problem does it solve? -->
<!--- If it fixes/closes/resolves an open issue, please link to the
issue here -->
Vastly improves documentation published to website.
## How Has This Been Tested?
<!-- (if applicable) -->
<!--- Please describe in detail how you tested your sample/changes. -->
<!--- Include details of your testing environment, and the tests you ran
to -->
<!--- see how your change affects other areas of the code, etc. -->
## Screenshots
<!-- (if appropriate): -->
## Types of changes
<!--- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Improvement (non-breaking change that adds a new feature)
- [ ] Bug fix (fixes an issue)
- [ ] Breaking change (breaking change)
- [ ] Documentation Improvement
- [ ] Config and build (change in the configuration and build system,
has no impact on code or features)
## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes
that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
You agree with the license terms and that other license types may be
granted with permission of the original `N64FlashcartMenu` project
license holders.
<!--- It would be nice if you could sign off your contribution by
replacing the name with your GitHub user name and GitHub email contact.
-->
Signed-off-by: GITHUB_USER <GITHUB_USER_EMAIL>
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Major restructuring and expansion of the user guide and table of
contents; many new and revised pages, formatting improvements, guidance
additions, and API/site doc generation configuration.
* **Chores**
* Added multiple containerized development environments and supporting
build scripts; CI workflow added to build and publish the documentation
site.
* **Style**
* Minor wording and title tweaks across docs; updated ignore rules and
documentation output paths.
<sub>✏️ Tip: You can customize this high-level summary in your review
settings.</sub>
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
53 lines
1.4 KiB
YAML
53 lines
1.4 KiB
YAML
- name: Index
|
|
href: 00_index.md
|
|
- name: Getting Started
|
|
href: 10_getting_started_sd.md
|
|
- name: Basic Controls
|
|
href: 11_menu_controls.md
|
|
- name: ROM Configuration
|
|
href: 12_rom_configuration.md
|
|
- name: Datel Cheats (Gameshark, Action Replay, etc.)
|
|
href: 13_datel_cheats.md
|
|
- name: ROM Patches (Hacks, Fan Translations, etc.)
|
|
href: 14_rom_patches.md
|
|
- name: Controller PAKs
|
|
href: 15_controller_paks.md
|
|
- name: Background Images
|
|
href: 16_background_images.md
|
|
- name: 64DD
|
|
href: 17_64dd.md
|
|
- name: Emulators
|
|
href: 18_emulators.md
|
|
- name: Game Art Images
|
|
href: 19_gamepak_boxart.md
|
|
- name: Autoloading N64 ROMs
|
|
href: 22_autoload_roms.md
|
|
- name: Sounds
|
|
href: 40_sound.md
|
|
- name: File Browser
|
|
href: 31_file_browser.md
|
|
- name: Menu Settings
|
|
href: 32_menu_settings.md
|
|
- name: Date-Time (RTC) Settings
|
|
href: 33_rtc_settings.md
|
|
- name: Menu Information
|
|
href: 35_menu_information.md
|
|
- name: Flashcart Information
|
|
href: 36_flashcart_information.md
|
|
- name: N64 Information
|
|
href: 37_n64_information.md
|
|
- name: MP3 Player
|
|
href: 41_mp3_player.md
|
|
- name: Advanced Customization
|
|
href: 61_advanced_customization.md
|
|
- name: N64 Hardware Modifications Compatibility
|
|
href: 62_hardware_mods.md
|
|
- name: Update the menu
|
|
href: 80_update_the_menu.md
|
|
- name: FAQ
|
|
href: 81_faq.md
|
|
- name: Experimental Features
|
|
href: 65_experimental.md
|
|
- name: Menu Developer Guide
|
|
href: 99_developer_guide.md
|