Show & Tell - Xiden Documentation Revamp

36 views
Skip to first unread message

Sage Gerard

unread,
Jul 2, 2021, 6:02:31 PM7/2/21
to Racket Users

Hey folks,

I did a pretty sweeping edit pass on Xiden's documentation. I'm really proud of it, and I'd like to show it off. https://docs.racket-lang.org/xiden-index/index.html?q=xiden%20documentation This revision of the docs uses a Guide [-> Exercises] -> Reference reading flow. It allowed me to delete a lot of extra text, but I don't know if it became easier or harder to understand. Could I get some feedback on just the guide and the transition to the exercises? What do you find clear/confusing? Did the examples work on your machine? etc.

--
~slg

Sage Gerard

unread,
Jul 2, 2021, 6:15:10 PM7/2/21
to racket...@googlegroups.com

Yikes, sorry about that. That's what I get for cross-posting HTML from another dark mode app. Looked the same to me. :)

Last try.

I did a pretty sweeping edit pass on Xiden's documentation. I'm really proud of it, and I'd like to show it off. https://docs.racket-lang.org/xiden-index/index.html?q=xiden%20documentation

This revision of the docs uses a Guide [-> Exercises] -> Reference reading flow. It allowed me to delete a lot of extra text, but I don't know if it became easier or harder to understand.

Could I get some feedback on just the guide and the transition to the exercises? What do you find clear/confusing? Did the examples work on your machine? etc.

Reply all
Reply to author
Forward
0 new messages