|
|
|
|
|
by twobyfour
3253 days ago
|
|
Multiple pages for the docs instead of trying to fit everything on one page. Everything on one page (especially if you use more javascript than is strictly necessary to display the docs - as Stripe does) is slower and makes it harder to find and bookmark things. When reading docs, I prefer to have tons of tabs open to various sections than to be constantly scrolling back and forth between them. And yeah, please also avoid 3-column. It may be convenient on a 4K display in horizontal layout, but not all of us are viewing on that sort of monitor at all times. Stripe's docs are even more painful than usual when your viewport is ~1Kpx wide. Pretty much everything on readthedocs.org is laid out comfortably. That's my gold standard. |
|