-
Notifications
You must be signed in to change notification settings - Fork 98
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
Enhance documentation for oras-go v2
#778
Comments
TODO: break down to more granular tasks |
It would be better if we have tutorials beyond examples like a tour of go. We don't need a full website and we can start with just a markdown file like the gin tutorial (rendered page). |
@Wwwsylvia I received a feedback about having the subject/referrer relationship made clear in the oras-go docs and add example code of how to add a subject using PackManifest would be super helpful. |
Here are some tasks I'm currently considering:
|
While we already have documentation covering the general concepts of ORAS on oras.land and detailed API specifications available on pkg.go.dev, users may still encounter challenges when trying to use
oras-go v2
in their projects.To enhance clarity and usability, we should consider the following improvements:
README.md
to include a brief summary of the library #813oras-go v2
#814Related issue: oras-project/oras-www#67
Feel free to share additional ideas or suggestions in the comments! Let’s make the documentation more accessible and user-friendly. 💡
The text was updated successfully, but these errors were encountered: