oak icon indicating copy to clipboard operation
oak copied to clipboard

Improve documenation

Open cletter7 opened this issue 10 months ago • 1 comments

Hi, it would be nice to have some documentation website with quick start guide, recipes, best practices, caveats, etc. Currently for a user like me who just starts with oak the docs are a bit confusing. There is https://oakserver.org/ website with a couple of pages, where the "See the docs" button leads to symbols list on jsr, and there is also github's readme. The information is scattered and seems not complete. Would appreciate the well structured thought through documentation.

cletter7 avatar Mar 11 '25 11:03 cletter7

The GitHub README has the best docs. It's surprising to me that there isn't anything as information dense in the actual docs.

The docs on JSR have almost no examples in them. For example, the send static content from the README is nowhere to be found on JSR, even though context.send says its possible.

kyeotic avatar Mar 19 '25 20:03 kyeotic