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: (3) Documentation #161

Closed
avivace opened this issue Feb 17, 2020 · 9 comments
Closed

List Review: (3) Documentation #161

avivace opened this issue Feb 17, 2020 · 9 comments

Comments

@avivace
Copy link
Member

avivace commented Feb 17, 2020

See #158 for context

  1. Game Boy Programming Manual - Official Game Boy programming and hardware manual by Nintendo.
  2. Pan Docs - Historical comprehensive technical reference, wikified, corrected and updated.
  3. The Cycle-Accurate Game Boy Docs - A precise documentation by AntonioND to make a cycle-accurate Game Boy emulator.
  4. Game Boy: Complete Technical Reference by Gekkio.
@ISSOtm
Copy link
Member

ISSOtm commented Feb 17, 2020

  1. Keep. We keep finding new things in it; also, historical value
  2. Change to the new version?
  3. Isn't it superseded by other documents?
  4. Keep.

@avivace
Copy link
Member Author

avivace commented Feb 17, 2020

  1. Which document (a part from GBCTR) supersedes that?

@meithecatte
Copy link

  1. Keep, but mention that despite being official, the docs are sub-par and have mostly historical value.

@avivace
Copy link
Member Author

avivace commented Feb 17, 2020

@NieDzejkob sub-par to what? What other documentation are you thinking of?

@ISSOtm
Copy link
Member

ISSOtm commented Feb 17, 2020

In readability and depth.

@meithecatte
Copy link

@avivace Pan Docs & the opcode table go a long way. There's also man 7 gbz80 from rgbds.

@avivace
Copy link
Member Author

avivace commented Feb 17, 2020

Semi unrelated: Diagrams from that manual are really good. I've started to port some of them on pan docs.

@aaaaaa123456789
Copy link
Member

1: agreed with above; if you're keeping it here and not moving it to the beginning of the list, mention that it's mostly there for its historical value and not a good reference
2: replace with the new wiki link. I'd still point to the old document, too (not the wiki, but the actual document), because it's been the canonical reference for ages and people would probably still want to be able to find it quickly.
3, 4: not too sure about the quality of these documents; they seem well made, but also outdated. Someone should probably review them.

@ISSOtm
Copy link
Member

ISSOtm commented Feb 18, 2020

What would have outdated gb-ctr?

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

4 participants