Avail-Js Documentation Test
Tested Avail-Js-Sdk with setup,configuration,and appId Generation
About
The problem it solves The feedback highlights a critical issue in the Avail documentation regarding the setup process for developers using the avail-js library. It points out that prerequisites for using the library were not clearly articulated, which can lead to confusion and impede the onboarding experience. For example, the documentation lacks a comprehensive overview of hosted endpoints, which is essential for understanding how to interact with the Avail network effectively. Additionally, the link to the appId generator provided in the documentation was broken, resulting in a 404 error. This makes it difficult for developers to generate the necessary credentials for using the library. By addressing these shortcomings, the feedback seeks to improve accessibility to key information, allowing developers to get started with the Avail library more smoothly and without encountering unexpected obstacles.
How it's made
Challenges we ran into During the testing of the Avail setup, several challenges were encountered that impacted the overall user experience. One notable challenge was the lack of clarity in the prerequisites and setup instructions for the avail-js library. This ambiguity hindered the ability to successfully interact with hosted endpoints and caused delays in configuring the environment correctly. Furthermore, there were issues in generating an appId, as the recommended generator web application was inaccessible. This not only wasted time but also created uncertainty about the steps needed to proceed with the setup. Additionally, there were complications related to running the Avail node on Windows, specifically when utilizing Docker. Developers faced difficulties in executing the Docker command due to issues such as manifest file errors. These challenges further complicated the setup process, highlighting the need for clearer instructions and a more thorough troubleshooting guide in the documentation. By addressing these issues, the overall experience for developers can be significantly improved, allowing them to navigate the initial setup with greater ease and confidence.