Versions Compared

Old Version 19

changes.mady.by.user Kajal Kumari

Saved on

compared with

New Version Current

changes.mady.by.user Kajal Kumari

Saved on

Key

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

...

I will be mentioning my ideas here for the documentation task force.

Initial Ideas :

GitHub templates and best practices :

  1. Creating a standard pull request template for the GitHub repository. 
  2. Creating a standard issue template for the GitHub repository. 
  3. Using automation for closing the issue and PR.
  4. Creating coding guidelines 

Project templates and best practices :

A standard documentation template for all projects should be there. The template should include the following: 

  1. Purpose of the project so that users can understand what the project is about, enhancing user experience.
  2. Describe how to use the project, the mechanism, and the functionalities of various features. Make the reader understand the technology, before using it. Gives instructions on how to do the specific task. It consists of steps that need to be followed.
  3. Provide relevant links, code snippets, and algorithms. 
  4. Provide images, graphics, tables, flow charts, user flow, etc.
  5. Feedback from users 
  6. Conclusion and people to contact for more information (maintainers, project mentor)

Resources:

As I am the Committee Chair for Templates. I will be focusing and working on templates for GitHub and documentation. 


27 July 2023: AI Task Force Presentation 

Slide Link

13 July 2023: TOC Presentation:

Slide Link

14 June 2023: Hyperledger Mentorship Onboarding Presentation

Slide Link


AI TOOLS : 

  • CHATGPT
  • LOOKA.COM
  • CLIPDROP

...


Had a conversation with the Caliper maintainer about enhancing the Caliper documentation.

The doc uses a custom template (https://hyperledger.github.io/caliper/, https://github.com/hyperledger/caliper/tree/gh-pages), which is designed pretty nicely, but there are some usability and maintainability issues:

...

I need to discuss with him the documentation goals of Anoncreds. Not sure in what I have to contribute to. As I am the Committee Chair for Templates. I will be focusing and working on templates for GitHub and documentation. 

Reference

Best Practices Badges / Templates

Creating a Template

New design template:

https://www.canva.com/design/DAFlKRYU5Wg/jbIyWSl5lXIpOI4LwB5SLg/edit?analyticsCorrelationId=5ce23bab-868c-4451-a13f-798875528744


Initial Ideas :

    

GitHub templates and best practices :

  1. Creating a standard pull request template for the GitHub repository. 
  2. Creating a standard issue template for the GitHub repository. 
  3. Using automation for closing the issue and PR.
  4. Creating coding guidelines 

Project templates and best practices :

A standard documentation template for all projects should be there. The template should include the following: 

  1. Purpose of the project so that users can understand what the project is about, enhancing user experience.
  2. Describe how to use the project, the mechanism, and the functionalities of various features. Make the reader understand the technology, before using it. Gives instructions on how to do the specific task. It consists of steps that need to be followed.
  3. Provide relevant links, code snippets, and algorithms. 
  4. Provide images, graphics, tables, flow charts, user flow, etc.
  5. Feedback from users 
  6. Conclusion and people to contact for more information (maintainers, project mentor)

Resources:

Created a pull request template: https://github.com/hyperledger-labs/documentation-template/pull/12 (merged)