Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List Review: (4) Documentation > Misc #162

Closed
avivace opened this issue Feb 18, 2020 · 2 comments
Closed

List Review: (4) Documentation > Misc #162

avivace opened this issue Feb 18, 2020 · 2 comments

Comments

@avivace
Copy link
Member

avivace commented Feb 18, 2020

See #158 for context

1 - Introduction to Game Boy Hacking - Workshop introducing basic assembly, debugging and reverse engineering.
2 - Everything You Always Wanted To Know About GAME BOY - but were afraid to ask
3 - GBSOUND.txt - A document detailing the Game Boy sound engine.
4 - GB Instructions Game Boy Assembly commands.
5 - GB ASM Tips - Some tips for coding in Assembly by Jeff Frohwein.
6 - gbdev FAQs - Must read by Jeff Frohwein.
7 - Game Boy Bootrom - Commented dump of the DMG bootrom.
8 - GB Technical Information - Some old code resources.
9 - Differences between the Z80 and the gameboy's processor
10 - Gameboy 2BPP Graphics Format - Information on how the Game Boy interprets VRAM tile data to color pixels.

@avivace avivace changed the title List Review: (4) List Review: (4) Misc Documentation Feb 18, 2020
@avivace
Copy link
Member Author

avivace commented Feb 18, 2020

Okay, this is gonna be long.

  1. Keep
  2. Remove. This is an old version of Pan Docs.
  3. Move to a Sound section. Do we have an updated document with a similar scope? Should we move that in the Pan Docs as "side tutorial"?
  4. Move. This is more related to ASM programming than a general documentation resource
  5. Same as 4.
  6. Outdated, but we need an updated FAQ document.
  7. Move. Not sure where, but I don't the the utility of having the bootrom as a Documentation resource.
  8. Move. THis is a directory of old resources, not sure if there's something we'd want to link directly.
  9. There's a chapter of Pan Docs covering this. Check if all the information is there and in case directly link that chapter.
  10. Move to a chapter dedicated to Video?
  11. Miscellanea/uncategorized should be the last section, or anyway not at the top.

@ISSOtm
Copy link
Member

ISSOtm commented Feb 18, 2020

  1. Mixed opinion. It's good, but outdated (refers to a much earlier state of the disassembly, it has improved a lot since then. Not sure the constants it's referring to haven't changed names since; if that's the case, I'm for removal unless it gets updated)
  2. Delet
  3. Not sure either. The format isn't great, and a lot of the info is now covered by Pan Docs. Plus there are typographical and grammatical errors (plus a .txt file that was clearly intended to be read with a certain viewport size) that hinder comprehension.
  4. Agree to move, but it's superseded by gbz80(7) anyways.
  5. Keep & move.
  6. Some parts are severely outdated, other parts are still good and relevant. Against keeping it as-is, but it'd be a good idea to make a copy with some sections (such as those about official devkits) elided.
  7. Superseded by gb-bootroms. Relevant both to emulator devs and as historical info, so I think it fits a misc section.
  8. Outdated.
  9. Same. Might be worth porting to Pan Docs with attribution if it's incomplete in the current docs.
  10. Good as a general resource to emulator devs and all programmers. Create a "technical references" section maybe?
  11. Yep.

@avivace avivace changed the title List Review: (4) Misc Documentation List Review: (4) Documentation > Misc Feb 19, 2020
avivace added a commit that referenced this issue Feb 27, 2020
@avivace avivace closed this as completed Feb 27, 2020
avivace added a commit that referenced this issue Mar 17, 2020
* List review (#159): Move down PyBoy to Emulator Development section

* List review (#160): Remove wiki, move devrs down to Websites. Improve link names.

* List review (#161): reorder, update Pan Docs link, specify historical relevance for the official manual.

* List review (#162): remove/move old links, move section to the bottom of the Documentation section

* GBAdev disambiguation (#164)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants