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.

Sign up for GitHub

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

Jump to bottom

Doc: improve README #40

Merged

yunwei37 merged 14 commits into main from doc

Feb 24, 2023

Member

yunwei37 commented Feb 23, 2023 •

edited

Loading

move build to doc/build.md
move examples to examples/README.md
add go examples description
add rust runtime description

Any more suggestions? The Chinese documents improvement should be in another PR.

Littlefisher619 added 4 commits

February 24, 2023 02:32


          doc: move examples in README

38f5404


          doc: add go example in README

08dfa68


          doc: update the build.md

658f038


          doc: fix how it works

141c75a

yunwei37 requested a review from Officeyutong

February 23, 2023 18:58

pull-request-size bot added the size/XL label

yunwei37 requested review from ocfox, qq906907952, saivian1, septs and try-agaaain

February 23, 2023 18:59

Member Author

yunwei37 commented Feb 23, 2023 •

edited

Loading

shall we keep an example output in readme， to show the usage of this?

septs reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

septs reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

septs reviewed

View reviewed changes

docs/build.md Outdated Show resolved Hide resolved

septs reviewed

View reviewed changes

docs/build.md Outdated Show resolved Hide resolved

septs reviewed

View reviewed changes

docs/build.md Outdated Show resolved Hide resolved

septs reviewed

View reviewed changes

docs/build.md Outdated Show resolved Hide resolved

septs reviewed

View reviewed changes

docs/build.md Outdated Show resolved Hide resolved

ocfox reviewed

View reviewed changes

docs/build.md Outdated Show resolved Hide resolved

docs/build.md Outdated Show resolved Hide resolved

docs/build.md Outdated Show resolved Hide resolved

examples/README.md Outdated Show resolved Hide resolved

yunwei37 and others added 8 commits

February 24, 2023 13:24


          Update README.md

628d0c3

Co-authored-by: septs <[email protected]>


          Update README.md

93ae005

Co-authored-by: septs <[email protected]>


          Update docs/build.md

89d2514

Co-authored-by: septs <[email protected]>


          Update docs/build.md

Co-authored-by: septs <[email protected]>


          Update docs/build.md

7e92aa7

Co-authored-by: septs <[email protected]>


          Update docs/build.md

Co-authored-by: septs <[email protected]>


          Update docs/build.md

b9aa7fb

Co-authored-by: septs <[email protected]>


          Update examples/README.md

673f8ea

Co-authored-by: ocfox <[email protected]>

ocfox reviewed

View reviewed changes

README.md Outdated Show resolved Hide resolved

examples/README.md Show resolved Hide resolved


          update documents for example desc

76eede4


          replace example and how it works

2c090cd

yunwei37 merged commit fca7030 into main

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

septs septs left review comments

ocfox ocfox left review comments

Officeyutong Awaiting requested review from Officeyutong

qq906907952 Awaiting requested review from qq906907952

saivian1 Awaiting requested review from saivian1

try-agaaain Awaiting requested review from try-agaaain

Labels