pc-dart icon indicating copy to clipboard operation
pc-dart copied to clipboard

Write complete guide for usage (Documentation issue)

Open AKushWarrior opened this issue 5 years ago • 3 comments

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 avatar May 26 '20 05:05 AKushWarrior

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.)

AKushWarrior avatar May 27 '20 23:05 AKushWarrior

Some other ideas :

  • Create a documentation page and host it via github pages.
  • write some articles at medium.com

Ephenodrom avatar Jul 22 '20 20:07 Ephenodrom

* 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!

AKushWarrior avatar Jul 22 '20 23:07 AKushWarrior