...
- Add Visuals: The addition of visuals is needed like
- screenshots of code snippets for making it more interactive.
- flowcharts, and block diagrams for better Understanding.
There are many options available for creating diagrams. Three options that are free or have free options include:
Section-wise improvements in the documentation after the introduction:
- Installing Solang:
Remark - The installing section is not beginner friendly. It is challenging for a user who wants to try it out and learn about it. The first step of setting up should be easy, not overwhelming.
Improvement suggestion - 1. Redesigning the section and making it more simple.
2. Adding screenshots for specific devices.
3. The language used is using too many technical terms without any explanation about them, we can define them and make it more noob-friendly.
Work Flow
Attended 16th June 23 Solang Community meeting.
...
- Existing documentation of Solang: https://solang.readthedocs.io/en/latest/
Suggestions
1. While making changes in the documentation, we can follow the Google developer documentation style guide: https://developers.google.com/style
- Useful for Helpful in maintaining uniformity throughout the documentation.
...