purescript / pursuit

Website for hosting and searching PureScript API documentation

https://pursuit.purescript.org/

Other

170 stars 47 forks source link

Link to README in case it can't be show due to rate limiting #417

Closed andys8 closed 3 years ago

andys8 commented 4 years ago

Currently if there is the README can't be fetched due to rate limiting, pursuit is showing:

https://github.com/purescript/pursuit/blob/d995a0411c65aa4506074f10acc95188f550502b/src/TemplateHelpers.hs#L125-L129

Possible improvement

We could add a hint ("Click here to open README instead") and additionally link to https://<REPO>/blob/master/README.md

hdgarrood commented 4 years ago

I would actually prefer to stop using the GitHub API for readme rendering entirely; see #150 and https://github.com/purescript/purescript/issues/3917

andys8 commented 4 years ago

In that case the issue would be superseeded.

150 is 5 years old. Is this issue a small improvement one could do anyway? Otherwise I'm gonna close it :)

hdgarrood commented 4 years ago

Yeah, we could do this instead anyway. Using "click here" as link text is generally best avoided in favour of using more direct, descriptive language - especially for screen readers - so I'd rather the link text be "view this package's readme on GitHub".