andromedaprotocol/andromeda-core

Document STD Crate

Opened this issue · 0 comments

Description

Currently our STD crate is heavily undocumented, making it difficult to use for external developers. This is true both in terms of commenting but also in terms of READMEs, especially for our feature heavy modules.

Implementation

We should make sure to comment all public facing methods and add READMEs for the following:

  • STD Package
  • ADO Base
  • ADO Contract
  • Permissioning
  • Ownership

Acceptance Criteria

  • All public facing methods are commented
  • Additional READMEs for the listed modules