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

docs(readme): move more example to docs/doc.md #3449

Merged
merged 7 commits into from
Jan 2, 2023

Conversation

thinkerou
Copy link
Member

@thinkerou thinkerou commented Dec 25, 2022

@appleboy please review, thanks!

Motivation:
moving API examples to docs/doc.md, reduce length of README and use weight of page for reading example code.

Result:
before:
image
after:
image

@codecov
Copy link

codecov bot commented Dec 25, 2022

Codecov Report

Merging #3449 (fe741cb) into master (e868fd1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3449   +/-   ##
=======================================
  Coverage   98.63%   98.63%           
=======================================
  Files          42       42           
  Lines        3139     3139           
=======================================
  Hits         3096     3096           
  Misses         29       29           
  Partials       14       14           
Flag Coverage Δ
98.63% <ø> (ø)
go-1.16 ?
go-1.17 98.53% <ø> (ø)
go-1.18 98.53% <ø> (ø)
go-1.19 98.63% <ø> (ø)
macos-latest 98.63% <ø> (ø)
ubuntu-latest 98.63% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@thinkerou thinkerou requested a review from appleboy December 25, 2022 06:11
@thinkerou thinkerou added this to the v1.9 milestone Dec 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants