tweag / webauthn

A library for parsing and validating webauthn/fido2 credentials
Apache License 2.0
34 stars 11 forks source link

Revise documentation and write more if needed. #106

Open infinisil opened 2 years ago

infinisil commented 2 years ago

This includes things like checking all module header docs, field docs, seeing if the docs render nicely, if some fields should have docs that currently don't have docs. Also checking function argument docs (notably haddock doesn't warn if function args aren't documented).

infinisil commented 2 years ago

Very important, the specifications section on Security considerations for Relying Parties should be prominently pointed out in the docs, or maybe even inlined