Skip to content

API docs: "Usage examples" header too small & could optimize usage example display area on individual pages

Created by: slimsag

https://sourcegraph.slack.com/archives/C027YMRP648/p1631577435009500?thread_ts=1631573304.007500&cid=C027YMRP648

https://www.figma.com/file/H0HrT0MZ1QDcan7zq8pCut?node-id=31:7609#108723049

From Dan Adler:

Quick micro feedback: the header “Usage examples” feels too small to me. It visually doesn’t stand out at all to me, so when I look at the page quickly, I don’t see that it’s there. Given it’s the most unique part of our docs pages, I think it deserves a bigger/bolder header.

Also: have you ever considered showing more lines around the examples? I see some whitespace, comments around variable declarations, etc. I feel like having 5 or 7 or 9 lines for each example would draw the eye to it more…