Improve packages READMEs #1159
Improve packages READMEs #1159
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1159 +/- ##
=======================================
Coverage 88.87% 88.87%
=======================================
Files 57 57
Lines 1375 1375
=======================================
Hits 1222 1222
Misses 153 153 Continue to review full report in Codecov by Sentry.
|
packages/access/README.md
Outdated
| > **NOTE:** This document is better viewed at https://docs.openzeppelin.com/contracts-cairo/api/access | ||
| > **NOTE:** This document is better viewed at [https://docs.openzeppelin.com/contracts-cairo/api/access](https://docs.openzeppelin.com/contracts-cairo/api/access) |
There was a problem hiding this comment.
I'm wondering if we should add the version to all the URLs. If users are not using the latest version, I think it'd be nice to directly link to the specific version in the docsite
There was a problem hiding this comment.
Good point, I will update, but it will make it into the next release, since all the packages have been uploaded to the registry already.
| > **NOTE:** Documentation will soon be added to [https://docs.openzeppelin.com/contracts-cairo](https://docs.openzeppelin.com/contracts-cairo) | ||
|
|
Co-authored-by: immrsd <103599616+immrsd@users.noreply.github.com>
This PR fixes a copy-paste issue in the introspection package README, also accommodates READMEs to the UI of the scarb registry (fixing links not showing), and adds some extra links.