Sunbird RC- Documentation Stack Revamp

[manukalia29]

Hey Everyone,

We are kickstarting an effort to revamp the Sunbird RC documentation stack to make it more organized and accessible.
As the documentation stack continues to evolve, it is important to ensure that all personas are taken into account when revamping the documentation. For our stack we have considered below mentioned personas:

1. Business users - Organizational decision maker
2. Adopters/Implementers e.g., Functional persons/team from adopter organization
3. Developers

We have analyzed the entire documentation stack and found some key issues in the documentation:

1. Restructuring/reordering of the documentation is required with more sections to be added on setting up the context and need of sunbird RC.
2. Currently the structure and content are too focused on technical stack that can be restructured and grouped under user guides with defined audience type- Developer guide, implementer guide which is more functional and works for a project manager bureaucrat type of role.
3. Demo videos and screenshots are required as a hand holding step by step guide to the developer community.
4. Make it easy to install/deploy
   a. Set up Instruction should be detailed with screenshots
   b. Installation instructions on Docker and Kubernetes must be given separately.
   c. A detailed process (video or screenshots) from deployment to certificate generation should be given
5. Details of the sequence of the APIs to be called to test end to end functionality of the backend system.
6. Detailed information on Verifiable Credentials and W3C standards should be provided.
7. Postman collection of APIs can be provided with detailed instructions.
8. Sample workflows and examples are missing. Each sample should have:
   • Use-case
   • Visual workflow
9. Wherever possible the textual content should be supported with pictorial representation.

To ensure that documentation stack is up to date and meets the needs of the key personas, As the next steps:

• A brief Table of Contents (ToC) has been created with the aim of providing an overview of all the topics covered in the documentation and which all sections need amendments. We welcome any feedback or suggestions from the community to help improve the documentation and make it more user-friendly.
• Also, we have started drafting the few sections in the GitHub and will keep you posted time to time on the progress.

[manukalia29]

Hi Everyone,

We have completed the verifiable credential section of the documentation. Pasting the link to access and review the documentation. I would appreciate if you could take a look at it and provide your valuable feedback. @parthlawate @surendrasinghs

https://docs.sunbirdrc.dev/learn/verifiable-credentials

[manukalia29]

Hi Everyone,

We have published the Electronic Registries and Sunbird RC section of the documentation. Sharing the link to access and review the documentation.
https://docs.sunbirdrc.dev/learn/electronic-registries
https://docs.sunbirdrc.dev/learn/readme