search

oras-project / oras-go

ORAS Go library
https://oras.land
Apache License 2.0
168 stars 90 forks source link

Enhance documentation for `oras-go v2` #778

Open Wwwsylvia opened 2 weeks ago

Wwwsylvia commented 2 weeks ago

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:

Related issue: https://github.com/oras-project/oras-www/issues/67

Feel free to share additional ideas or suggestions in the comments! Let’s make the documentation more accessible and user-friendly. 💡

Wwwsylvia commented 1 week ago

TODO: break down to more granular tasks

shizhMSFT commented 1 week ago

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).