Commit Graph

3 Commits

Author SHA1 Message Date
Robin Jones
38093cb1df Fix save types for NES, GB, GBC
Revert GB64 to use FLASHRAM, Users seem to experience more issues with SRAM
Add documentation warning about certain NES emulator releases.
2025-06-13 19:01:19 +01:00
Víctor "IlDucci
7f97c2ff4e Docs proofread/rewrites (#206)
## Description
Proofread and partial rewrite of the docs.

## Motivation and Context
Adding more information written in an user-friendly way (not just
developer-friendly way), writing materials that were left to do,
cleaning up existing materials.

## 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)
- [x] Documentation Improvement
- [ ] Config and build (change in the configuration and build system,
has no impact on code or features)

## Checklist:
- [ ] My code follows the code style of this project.
- [x] My change requires a change to the documentation.
- [x] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **Documentation**
- Updated multiple documentation files with improved clarity,
consistency, and formatting
- Refined section titles and headings across various documentation pages
	- Enhanced explanations and instructions for N64FlashcartMenu features
- Improved navigation links and added more descriptive return-to-index
references

<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Robin Jones <networkfusion@users.noreply.github.com>
2025-01-20 23:51:08 +00:00
Robin Jones
1a9e292598 [develop] Documentation manual (#198)
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
Reworks and splits the documentation.

## 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 -->
Improves documentation to be more readable.

## 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)
- [x] 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.

<!--- 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

Based on the comprehensive summary, here are the release notes:

- **New Features**
  - Added ROM history and favorites functionality
  - Introduced tabbed interface for file browsing
  - Implemented ROM information descriptions
  - Added support for ROM configuration overrides
  - Enhanced menu settings management

- **Documentation**
  - Expanded user guide and documentation
  - Added sections on ROM patches, controller PAKs, and emulator support
  - Improved flashcart and menu customization instructions

- **Chores**
  - Updated documentation structure
  - Refined code organization and naming conventions
  - Updated subproject references

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2025-01-12 23:41:32 +00:00