caketop / python-starlark-go

🐍 Python bindings for starlark-go 🐍
https://python-starlark-go.readthedocs.io/
Apache License 2.0
20 stars 7 forks source link

Add link to docs in repo 'website' section? #175

Closed tadamcz closed 1 year ago

tadamcz commented 1 year ago

This is quite a silly thing, but I originally missed the 'docs' badge here, which is the only link to the documentation on the README:

image

When you Cmd+F on the page for the strings docs, the badge is not matched (at least in Chrome). So it took me a little bit of time to find the docs 🤦, which I only did when I cloned the repo and opened the README in a markdown editor.

Adding a link to https://python-starlark-go.readthedocs.io/ in the 'website' section on the right-hand side of the repo would be very low effort, and potentially might help at least one other person get started with your library 🙂.

jordemort commented 1 year ago

Good idea, I've added the link.