You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 11 Next »

  • Email(star):  tripurjoshi3121@gmail.com

     User Documentation Improvements needed (for Solang)(I will add more points. Work in progress! (red star))
  • Introduction: The introduction section could be more informative and provide a brief overview of the Solang Solidity Compiler. It should clearly explain the purpose of the compiler, its features, and its compatibility with other Solidity compilers.
  •  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:






(lightbulb) Work Flow 

Attended 16th June 23 Solang Community meeting.

  •  The members need a lot of help with the documentation. 

They have the following requirements: 

  1) Want beginner-friendly documentation of Solang.
  2) Tutorial on how to set up Solang in different operating systems like macOS, Linux, etc. (Setting Up Your Development Environment for Solang: A Step-by-Step Guide)
  3) Getting Started with Solang: A Beginner's Guide. 
  4) Building Projects with Solang: A Comprehensive Tutorial
  5) Developing Smart Contracts on Solang: Step-by-Step Guide (Solang Basics: An Introduction to Solidity-based Contract Development)
  6) Invoking Nested Contracts: A Guide to Calling Contracts within Contracts
  7) Comprehensive Guide to Writing, Testing, and Deploying Smart Contracts in Solidity with Solang
         (Understanding Solang Syntax and Solidity Concepts for Beginners, Testing and Debugging Smart Contracts with Solang: Best Practices for Beginners)
  8) Writing Your First Smart Contract with Solang: A Hands-On Tutorial
  9) Exploring Advanced Features of Solang: A Next-Level Guide for Beginners
 10) Solang Security: Tips and Best Practices for Beginner Developers
 11) Solang Tools and Utilities: Enhancing Your Smart Contract Development Workflow for Beginners


(blue star) Suggestions (blue star)

1. While making changes in the documentation, we can follow the Google developer documentation style guide: https://developers.google.com/style

  • Useful for maintaining uniformity throughout the documentation.

2. For flowcharts and diagrams, we could use Draw.io: https://app.diagrams.net/

  • We can do real-time collaborations.
  • It has a beginner-friendly interface and pre-made layouts.
  • No labels