we should check that documentation covers all API calls: Majority of public API methods are not covered in the documentation. Consider creating a separate documentation page dedicated solely for the C# API.
we should check that documentation is clear and contains no typos: Single-page documentation with setup, API and other details is difficult to follow and navigate
Check if public facing source code is summarized / commented
Actions to take:
Adding documentation and comments on methods (in .cs and .md files) .
Adding a single-page documentation for API calls (README-Api.md was added).
Unity team found that:
Actions to take:
.cs
and.md
files) .README-Api.md
was added).