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

Already on GitHub? Sign in to your account

More responsiveness/width-flexability in the devs-docs section #723

Closed
jonasschnelli opened this Issue Jan 28, 2015 · 1 comment

Comments

Projects
None yet
3 participants
Contributor

jonasschnelli commented Jan 28, 2015

Reading the docs is pretty hard because the docs frame cannot be resized or anything like that.
It would be nice to have a option to view the docs in bar .MD (simple bootstrap css?).
Cool would be a option to fullscreen the page and toggle in/out the navigation.

Maybe this exists already.

This is how it looks on my screen.
bildschirmfoto 2015-01-28 um 13 44 03

Contributor

harding commented Jan 28, 2015

@jonasschnelli yeah, the layout in the API section is cramped with regard to the tables and code examples. I think the rest of the docs, which is mostly paragraphs and images, works fine.

This leaves us something of a conundrum: I'd love to see the width increased (when screen sizes allow) for the API section, but I'd hate to see the width increased for the regular paragraph text. (Studies show text lines with more than about 80 characters are hard to read. Somewhere around 65 characters seems to be optimum.)

Maybe we could just tweak the current API layout to provide more space. E.g. instead of using text descriptions for the "Type" and "Presence" fields, we could use icons with hover text. For example, as seen below, instead of "number (int)", use ℤ, and instead of "Required (exactly 1)", use ☑. The hover text would still have the full description. This gives the "Description" field much more space.

2015-01-28-090608_621x167_scrot

For the example JSON output, it would be trivial to reflow the indentation tab stops to 2 spaces per stop rather than bitcoin-cli's default 4 spaces per stop. That would provide a small but real condensation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment