search

lgwillmore / warden

Kotlin Attribute Based Access Control
MIT License
19 stars 3 forks source link

Docs - Example Projects #13

Open lgwillmore opened 3 years ago

lgwillmore commented 3 years ago

Give some example projects

aSemy commented 2 years ago

I've tried working with Warden but it's really hard to see what to do, or the best way to achieve my goals. Part of the problem is the limited KDoc, and also there's only one (incomplete) example.

I would really like it if there was documentation like in Kotlinx Serialization https://github.com/Kotlin/kotlinx.serialization/tree/master/docs. It uses Knit to ensure the example code is tested and works. Implementing Knit (or something similar if it exists?) would really help with creating examples and demonstrations, and making sure they're kept up-to-date.

I can provide a quick POC demo.

lgwillmore commented 2 years ago

Hey, ya. Busy doing a documentation refresh at the moment.

Very happy if you want to create a new submodule in the project as an example jvm project

Will have a look at Knit, but I think I will get all the content I want into the existing orchid/netlify publishing first.

lgwillmore commented 2 years ago

Actually, let me quickly add a demo project module. Going to do a full ktor demo

lgwillmore commented 2 years ago

Liking Knit, and happy with the kotlinx serialization docs. Going to make a new issue for the migration - #42