Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize the documentations #3

Open
shuhaowu opened this issue Nov 3, 2021 · 0 comments
Open

Reorganize the documentations #3

shuhaowu opened this issue Nov 3, 2021 · 0 comments
Assignees

Comments

@shuhaowu
Copy link
Member

shuhaowu commented Nov 3, 2021

The docs right now is all in README.md, which is aimed at people who work in this repo, rather than the users. I can split the docs into two parts: a part aimed at developers and a part aimed at the users.

The build status image on the readme is also broken following the organization move as it linked to my repo. This can easily be fixed as well.

@shuhaowu shuhaowu self-assigned this Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants