Switch to new "bit explanation" format #334

ISSOtm · 2021-07-22T23:31:48Z

Fixes #318, #293

TODO:

Center text in fields, for better readability (e.g. CGB palette in the OAM table)

ISSOtm · 2023-08-16T22:46:52Z

Feedback on the design would be welcome! NR10, LCDC, OAM and BG attributes, palettes (both regs and CRAM), STAT.

There is also the second table in the tile data chapter, but it's a different, unique design.

ISSOtm · 2023-09-28T18:43:03Z

I'm not going to go over the MMM01 page, because it's too daunting even for me.

ISSOtm · 2023-09-28T19:22:15Z

I've converted almost everything: 3 SGB pages are remaining, and the MMM01 page. Plus anything I've missed, but honestly converting these is getting too tedious even for my tastes, and I'd rather get all of the existing conversions merged instead of making this PR linger in limbo any longer.

ISSOtm · 2023-09-28T19:26:21Z

Note: a render is still available at https://eldred.fr/pandocs. Please refer to the PR contents for a list of modified tables.

Recovered from a very old stash, hopefully I "rebased" correctly. Since this is changing the structure of the bit explanations, some modifications to the content have been made as well.

This guarantees good X overflow behaviour. Nice!

Fixes gbdev#403

avivace · 2023-10-03T22:15:07Z

DEPLOY.md

@@ -130,6 +130,51 @@ Note that the angle brackets [are only required if there are spaces in the URL](

 In effect, this means that linking to a section is as simple as copy-pasting its name in the URL field, prepending a `#`, and wrapping everything in `<>` if the name contains a space.

+### Bit breakdown tables


Are we sure this goes in DEPLOY.md and not CONTRIBUTING?

I agree, but all of the custom syntax is documented here: better keep it all together now, and move it in a separate PR?

avivace · 2023-10-03T22:15:55Z

preproc/src/preproc.rs

@@ -35,24 +40,75 @@ impl Preprocessor for Pandocs {
    }

    fn run(&self, _: &PreprocessorContext, mut book: Book) -> Result<Book, Error> {


Could we add some comments/documentation on what these new parts/functions of the preprocessor are doing?

avivace · 2023-10-03T22:22:38Z

preproc/src/preproc.rs

@@ -35,24 +40,75 @@ impl Preprocessor for Pandocs {
    }

    fn run(&self, _: &PreprocessorContext, mut book: Book) -> Result<Book, Error> {


Also, shouldn't we add some simple unit testing to this logic?

I'm not sure what you'd want to unit-test here, and not super hot on trying to build a mdBook book from scratch for testing purposes—to what extent is that stable? I'd like to avoid churn there.

avivace · 2023-10-03T22:23:10Z

preproc/src/preproc.rs

+    increasing: bool,
+}
+
+impl<'input> BitDescrAttrs<'input> {


Shouldn't this be tested as well?

ISSOtm · 2023-10-08T18:56:42Z

Honestly, thank you.

As discussed in gbdev#334 (comment)

As discussed in #334 (comment)

ISSOtm mentioned this pull request Jul 22, 2021

Styling for "bit explanation" tables/diagrams #318

Closed

ISSOtm added consistency - style Content format, text style, consistency in presenting the informations work in progress labels Jul 24, 2021

This was referenced Sep 4, 2021

Cleanup of MBC1 docs #312

Merged

Initial attempt at documenting MMM01 #310

Merged

ISSOtm mentioned this pull request Oct 2, 2021

Import GBC Infrared Communication from Dan Docs #366

Merged

avivace removed the work in progress label Oct 10, 2021

avivace force-pushed the master branch from bd754cd to b006ea1 Compare June 2, 2022 18:42

ISSOtm force-pushed the bit-expl branch 3 times, most recently from 23df373 to d7d175f Compare July 1, 2023 16:13

ISSOtm mentioned this pull request Jul 2, 2023

"Period changes take" in Audio_registers.md - NR13 paragraph #491

Closed

ISSOtm force-pushed the bit-expl branch from d7d175f to fa13a27 Compare August 16, 2023 22:50

ISSOtm force-pushed the bit-expl branch from fa13a27 to 847f12d Compare September 24, 2023 20:11

avivace self-requested a review September 24, 2023 21:19

avivace assigned avivace and ISSOtm Sep 24, 2023

ISSOtm marked this pull request as ready for review September 28, 2023 19:20

ISSOtm mentioned this pull request Sep 28, 2023

CPU Instruction Set Encodings #456

Closed

ISSOtm and others added 7 commits September 29, 2023 00:00

[WIP] Switch to new "bit explanation" format

df5c836

Convert some more bit tables

229548f

Recovered from a very old stash, hopefully I "rebased" correctly. Since this is changing the structure of the bit explanations, some modifications to the content have been made as well.

Move "bit explanation" table syntax to DEPLOY.md

d690799

Convert even more tables

a78c5d1

Wrap generated tables in same <div class="table-wrapper"> as mdBook

e4b9d7e

This guarantees good X overflow behaviour. Nice!

Convert all bit tables except MBCs and SGB commands

02ebbb6

Convert MBC1

806fdf4

ISSOtm added 2 commits September 29, 2023 00:00

Center text horizontally in bit descr tables

fa60517

Convert a ~third of the SGB commands

bc88f7d

ISSOtm force-pushed the bit-expl branch from b1250d8 to bc88f7d Compare September 28, 2023 22:00

Convert GameShark explanation to a table

cd72f94

Fixes gbdev#403

ISSOtm mentioned this pull request Sep 28, 2023

Interrupts section references z80 datasheets #293

Closed

ISSOtm changed the title ~~[WIP] Switch to new "bit explanation" format~~ Switch to new "bit explanation" format Sep 28, 2023

avivace requested changes Oct 3, 2023

View reviewed changes

avivace approved these changes Oct 8, 2023

View reviewed changes

avivace merged commit a3f9c08 into gbdev:master Oct 8, 2023
2 checks passed

ISSOtm added a commit to ISSOtm/pandocs that referenced this pull request Oct 23, 2023

Document custom markup in CONTRIBUTING instead

4418c24

As discussed in gbdev#334 (comment)

ISSOtm added a commit to ISSOtm/pandocs that referenced this pull request Oct 23, 2023

Document custom markup in CONTRIBUTING instead

ee03726

As discussed in gbdev#334 (comment)

ISSOtm added a commit to ISSOtm/pandocs that referenced this pull request Oct 23, 2023

Document custom markup in CONTRIBUTING instead

859a6c4

As discussed in gbdev#334 (comment)

ISSOtm mentioned this pull request Oct 23, 2023

Document custom markup in CONTRIBUTING instead #508

Merged

avivace pushed a commit that referenced this pull request Oct 23, 2023

Document custom markup in CONTRIBUTING instead (#508)

b8a2328

As discussed in #334 (comment)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Switch to new "bit explanation" format #334

Switch to new "bit explanation" format #334

ISSOtm commented Jul 22, 2021 •

edited by avivace

Loading

ISSOtm commented Aug 16, 2023

ISSOtm commented Sep 28, 2023

ISSOtm commented Sep 28, 2023

ISSOtm commented Sep 28, 2023

avivace Oct 3, 2023

ISSOtm Oct 4, 2023

avivace Oct 8, 2023

avivace Oct 3, 2023

avivace Oct 3, 2023

ISSOtm Oct 4, 2023

avivace Oct 3, 2023

ISSOtm commented Oct 8, 2023

		@@ -130,6 +130,51 @@ Note that the angle brackets [are only required if there are spaces in the URL](

		In effect, this means that linking to a section is as simple as copy-pasting its name in the URL field, prepending a `#`, and wrapping everything in `<>` if the name contains a space.

		### Bit breakdown tables

		@@ -35,24 +40,75 @@ impl Preprocessor for Pandocs {
		}

		fn run(&self, _: &PreprocessorContext, mut book: Book) -> Result<Book, Error> {

Switch to new "bit explanation" format #334

Switch to new "bit explanation" format #334

Conversation

ISSOtm commented Jul 22, 2021 • edited by avivace Loading

ISSOtm commented Aug 16, 2023

ISSOtm commented Sep 28, 2023

ISSOtm commented Sep 28, 2023

ISSOtm commented Sep 28, 2023

avivace Oct 3, 2023

Choose a reason for hiding this comment

ISSOtm Oct 4, 2023

Choose a reason for hiding this comment

avivace Oct 8, 2023

Choose a reason for hiding this comment

avivace Oct 3, 2023

Choose a reason for hiding this comment

avivace Oct 3, 2023

Choose a reason for hiding this comment

ISSOtm Oct 4, 2023

Choose a reason for hiding this comment

avivace Oct 3, 2023

Choose a reason for hiding this comment

ISSOtm commented Oct 8, 2023

ISSOtm commented Jul 22, 2021 •

edited by avivace

Loading