Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Page properties


Project TitleImprove Documentation for DRMan, Generate & Publish GitHub  pages using mkdocs
Status

Status
colourBlue
titlePending TOC Review

Primary Focus

Status
colourGreen
titleCoding
Status
colourBlue
titleDocumentation
  
Status
titleResearch


Description 

The task is to improve the documentation for DRMan, which aims to develop a utility for managing Verifiable Credential Registries. The core functionalities include creating, verifying, modifying, and revoking credentials, as well as managing DIDs. The project requires the creation of a DID registry for an organization, onboarding of members, and management of APIs needed to add/update/revoke access to DIDs or DID documents. The mentee is expected to use MKDocs to document the project and make it production-ready for future use.

Additional Information

The project  DRman has an end goal of developing a stand-alone utility to provision Verifiable Credential Registries [VCR]. The utility can also be used to administer the registry containing credentials issued by the organizations.  The functionalities like creation, verification, modification, and revocation of credentials, form the core of this project as it enables the administrator to manage the VCR with ease. 

...

This summer, the project needs active mentees who can document the project using MKDocs, thus making it production ready for future.

Additional Information

The Github Implementation has been successfully done by the mentees in the past. Now we need someone to make a great documentation out of it to make it a viable product for the future.

Learning Objectives

The mentee will have an opportunity to learn

  • Develop technical writing and documentation skills using tools such as MKDocs
  • Gain experience in contributing to an open-source project and collaborating with a development team
  • Enhance understanding of Verifiable Credentials Registries (VCR) and their functionalities
  • Learn Git and GitHub for version control and publishing documentation on GitHub pages
  • Develop problem-solving skills by working on the project's core functionalities such as creation, onboarding, and management of DIDs
  • The process of converting the architecture into an executable code.
  • Hands-on usage of Hyperledger Aries, Ursa, Indy.
  • Git, Shell Scripting, RUST.
  • Open-source contribution, documentation, and sense of ownership.
  • Opportunity to contribute to  articles, blog posts or white papers related to the project.

Expected Outcome

  • Proficient in both written and verbal communication.
  • Experienced in creating and improving technical documentation using mkdocs.
  • Skilled in presenting code as documentation, easy to use and understand for future contributors.
  • Knowledgeable in publishing documentation on Github pages, with expertise in Github for version control and collaboration.

...

Mentee Skills

Graduate or master's students s students preferred. Please do take a look at the skills.

...

Any experience with content creation, blogging, GSoD could be valued have additional value but is not strictly necessary

Future plans

The plan Our goal is to enhance the potential of  DRMan improve DRMan's capability to manage a full-featured complete DID Registry on GitHub and integrate it with GVCR. The project is expected to be seeded in Hyperledger Labs in the futureEventually, we plan to incorporate the project into Hyperledger Labs. Accurate and comprehensive documentation will make it easier to attract more contributions and volunteers to the project.

Mentor(s) Names and Contact Info

...