search

qmd-lab / closeread

https://closeread.dev
MIT License
128 stars 5 forks source link

Enhance docs #109

Closed jimjam-slam closed 3 weeks ago

jimjam-slam commented 4 weeks ago

Have filled the docs out a bit more and done some light editing! Still a few things missing, but I think they're mostly connected to fixes and features we haven't implemented yet. What do you think, @andrewpbray?

andrewpbray commented 4 weeks ago

This is excellent! As I look through your work, if I have small edits, I'll make them directly, but please feel free to object if you feel strongly!

andrewpbray commented 4 weeks ago

Before I implement this whole hog, I have a hot take to run by you: I'm not a fan of callout boxes 😬

I find my eye reads them first (because of the box, because of the color), before i get oriented to the hierarchy of the sections. Indeed they call my attention, but usually in a way that ruins my flow of parsing a page in a more linear fashion.

If you're strongly pro-callout, I'm totally fine keeping em in, but just thought I'd propose an edit :)

jimjam-slam commented 4 weeks ago

Haha, no worries at all — I do like callouts generally, but I don't have strong opinions on them here.

I tend to also use them for parenthetical stuff, too, and that stuff (ie. anything marked.callout-note) could probably be chucked into the margin or under a footnote instead! As you say, that stuff should probably be de-emphasised!