Giter VIP home page Giter VIP logo

Comments (4)

berendsliedrecht avatar berendsliedrecht commented on July 21, 2024

Hi. I think the documentation within the code has extensive examples on how to use this library. Since this library is not yet released, there is no docs.rs page, yet. Once it is, there will be a better way to view these examples. Also, you can take a look at the tests or usage in frameworks like ACA-Py and AFJ to see how it is used.

from anoncreds-rs.

TimoGlastra avatar TimoGlastra commented on July 21, 2024

I think this is a valid issue @berendsliedrecht, and seeing how it should be used from AFJ / ACA-Py is quite complex.

Some basic flow of what methods to call, in what order would be helpful. It could contain references to different languages, as the methods and input / output are almost exactly the same.

from anoncreds-rs.

berendsliedrecht avatar berendsliedrecht commented on July 21, 2024

Those flows are provided in the docs which will be available when the library is released. The codebase is full of examples like this, which is more than sufficient imo.

from anoncreds-rs.

swcurran avatar swcurran commented on July 21, 2024

What does docs.rs get us? Is it the docstrings from the code generated?

Is there sufficient material to produce a Mkdocs site from yet, or is documentation needed to be written?

from anoncreds-rs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.