bcgit / pc-dart

Pointy Castle - Dart Derived Bouncy Castle APIs
MIT License
237 stars 122 forks source link

Write complete guide for usage (Documentation issue) #15

Closed AKushWarrior closed 1 year ago

AKushWarrior commented 4 years ago

This library has always had an issue with documentation. I figured that I might take a crack at the issue; my work is at https://akushwarrior2.gitbook.io/pointycastle-a-guide/.

Not especially notable or anything, but I figured there should be a place for you guys to track my progress.

AKushWarrior commented 4 years ago

that site I put together isn't an end-all be-all by any means. It's just a cohesive way of dealing with the documentation issue. The best thing to do would be to use dartdocs, but that will take a while, so we need a stand-in. (@mwcw dartdocs are like a Dart analogue for javadocs. They're automatically compiled and displayed in a generated API reference.)

Ephenodrom commented 4 years ago

Some other ideas :

AKushWarrior commented 4 years ago
* Create a documentation page and host it via github pages.

This is probably what we want to do, instead of hosting on some random third-party.

* write some articles at medium.com

Good idea!