Skip to content

[Feature Request]: Update DocC #2

Description

@MasterJ93

Summary

The DocC needs to be updated with more useful information on how to best use this package.

Pain points

Right now, the DocC (both for ATIdentityTools and DIDCore) have the topics ordered. However, there's not enough context on how to use these libraries. There are no examples or additional information on what's needed for each item. Therefore, we need more useful information on how the packages can be used.

Considered Alternatives

We can leave it as-is, but as stated in the Pain Points section, there's not enough context on how to use the package.

Is this a breaking change?

No

Library Examples

No response

Additional Context

Here's a checklist on each of the things that should be added to the DocC.

  • ATIdentityTools

    • Add a sample app showcasing how to use the library.
      • Built for macOS
      • Built for Linux
    • Add example code and additional context for both HandleResolver and DIDResolver.
    • (Potentially) Add an article for explaining a certain concept.
  • DIDCore

    • Add a quick example on how to use it in the front page.
    • Add additional context to some of the methods and struct.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions