GSoC’22 Week 9 & 10: Comprehensive Documentations
This is the sixth in a series of blogs covering my journey as a contributor in GSoC ’22 at SCoRe Lab. Here, I share the progress of the project and just think out loud.
Progress Update
In these couple of weeks the objective was to work on the documentation of the package. Starting with the choice of Documentation Tool to be used, we curated guides for all the functionalities that NFT Toolbox is equipped with. Here are the details of the documentation that is now a part of the project.
Docusaurus Documentation
The initial decision to be made was the choice of Documentation Tool. The main candidates we had were Docusaurus, Gitbook and Retype. After careful consideration of their features and drawbacks, we decided to go with Docusaurus. It is Open Source, completely free to use and provides a Landing Page feature that the others do not have.
A Docusaurus project has been set up in the documentation folder. A Landing Page has been developed. And Markdown files covering detailed explanations and examples on how to use the package have been added for each functionality. Docusaurus allows us to generate a static build folder ready to be hosted from these Markdown files. With this the Documentation of the package is complete. However, the Landing Page can use some more styling. The theme and images on the Landing Page are the ones included in the Docusaurus Template. They can be updated whenever NFT Toolbox gets its own logo.
What’s Next?
The next couple of weeks will be the final weeks of our journey at GSoC’22. We will work on the deployment of the package and documentation. And lastly, we will prepare the submission required to complete the Final Evaluation.
That’s all for now. See you in the next blog!
