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: updated docs of the library #25

Merged
merged 5 commits into from
Jul 8, 2024
Merged

Conversation

Two-Hearts
Copy link
Contributor

@Two-Hearts Two-Hearts commented Jul 2, 2024

This PR updates the docs of this library.

Some RFC urls are removed from reference because Go doc automatically renders the RFC as a hyperlink. For example, RFC 3161 is rendered as a hyperlink pointing to the RFC 3161 doc online.

Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
@Two-Hearts Two-Hearts changed the title doc: updated docs docs: updated docs of the library Jul 2, 2024
Copy link

codecov bot commented Jul 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@d918484). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #25   +/-   ##
=======================================
  Coverage        ?   95.21%           
=======================================
  Files           ?       19           
  Lines           ?      732           
  Branches        ?        0           
=======================================
  Hits            ?      697           
  Misses          ?       18           
  Partials        ?       17           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

tspclient.go Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
@Two-Hearts Two-Hearts requested a review from shizhMSFT July 2, 2024 07:03
Copy link

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@JeyJeyGao JeyJeyGao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@Two-Hearts Two-Hearts merged commit 735fac6 into notaryproject:main Jul 8, 2024
9 checks passed
@Two-Hearts Two-Hearts deleted the doc branch July 8, 2024 23:47
This was referenced Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants