google / google/sbsim

Improve Documentation

Open
#105 0 comments 0 reactions 0 assignees View on GitHub
epic
Dominant language
Python
Stars
123
Forks
56
Avg merge
17d 18h
Merged PRs (30d)
3

Description

We should aim to document all public-facing functions and display them in the documentation site. The end goal is to expand the comprehensiveness and enhance the quality of the documentation site.

This issue can serve as an "epic". As collaborators improve existing documentation and add documentation for previously undocumented code, we can tag this issue to show progress towards this goal.

When we have satisfactory documentation coverage, we can consider closing this issue.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.