search

massung / r-cade

Retro Game Engine for Racket
https://r-cade.io
Other
273 stars 13 forks source link

Repository lacks documentation #3

Closed dented42 closed 4 years ago

dented42 commented 4 years ago

The documentation does live in the repository, which makes offline development difficult. Also having scribble documentation be part of the package allows raco to link it into the main racket documentation which, among other things, makes it searchable alongside the rest of the racket docs.

massung commented 4 years ago

This is something I definitely want to do, but I haven't found any trivial examples of scribble documentation to learn from (admittedly it's been a low priority thus far).

Most of the scribble docs I see are just about generating generic markup. I'm hoping there's just a subset of it that's used for Racket documentation.

If you have a link for me with an example package + functions documented, I'd be happy to.

massung commented 4 years ago

I've added scribble documentation that should be available when the Racket package system next builds (in the next 24 hours).