Might be late for this, but here’s a great list of examples: https://github.com/PharkMillups/beautiful-docs Scroll down for articles about writing docs and documentation generators.

4 Likes

12 posts were merged into an existing topic: Teletype docs enhancements (docs and cheatsheet live)

thanks @dan_derks for the super fast modding and thanks everyone for the feedback! If you have more feedback specific to the teletype docs styling redesign (or latex/pandoc toolchain and building), please keep it in that other thread.

we can keep this thread more general in providing tools to create, examples and ux patterns of good web docs sites.

3 Likes

is there a PR lined up for this? it looks fantastic!

@tehn Just local right now. My goal is to work on the proposed additional enhancements and fixes mentioned sometime this week and will open a pr sometime this upcoming weekend.

@alanza @scanner_darkly @sam do we have a concensus on what we want to do with the alphabetical ops section? It isn’t something I use personally (I go for the cheat sheet), so I’m not leaning one way or another. Just want to know what we want so I can work on it.

i think the discussion is still ongoing? would be great to hear from more people who use that section!

1 Like