Documentation additions/recommendations. Please review and adopt where it is correct/useful.

commanderx16 / x16-docs

Commander X16 Documentation (CC BY-SA)

189 stars 64 forks source link

Documentation additions/recommendations. Please review and adopt where it is correct/useful. #73

Closed FlightControl-User closed 2 years ago

FlightControl-User commented 2 years ago

Layout improvements, improve readability and style consistency.
Added comments in Memory Map section, adjusted table to reality.
Added comments and extended table in zero page section.
Added comments and notes in Banking section.
Fixed Mouse Config "communication" parameters.

First of all my appologies if I have said something wrong in my changes. Don't mean to offend or be "the wise guy". Please review and take what you find useful. Happy to contribute.

mist64 commented 2 years ago

Please no layout changes and content changes in the same patch. This makes it hard to find the content changes, and even completely masks the content changes within the lines you reformatted.

Also, the layout changes seem to mostly fix issues with the GitHub MarkDown renderer, while the .md is mostly meant for being converted into HTML during the build and bundled with the release, which uses a different MarkDown converter, which doesn't have these issues. Yes, a discussion can be had about whether it should render better on GitHub, but it'll have to start as a discussion, not a pull request, sorry.

FlightControl-User commented 2 years ago

I will close this pull request and reopen a new one.

FlightControl-User commented 2 years ago

@mist64 I will undo all my changes and will just send you some minor optimizations. The rest we can discuss first on a forum.

FlightControl-User commented 2 years ago

Sorry if I was a bit too energetic this morning. I do understand your feedback. So i'll do a new pull request for that communication register for the mouse config.