anuraghazra / anuraghazra/github-readme-stats

Improve project documentation and update error card

Open
#2,637 19 comments 0 reactions 0 assignees View on GitHub
enhancement proposal
Dominant language
JavaScript
Stars
79.8k
Forks
37.7k
PR merge metrics
No merged PRs in 30d

Description

> # Proposal
> It would be nice to have a semi-automatic, easy-to-maintain documentation website. This would provide a clear place for users to find documentation on the GRS tool, leading to fewer duplicate issues.
>
> _Added by rickstaa on 15-07-2023_

### Is your feature request related to a problem? Please describe.

![pic](https://user-images.githubusercontent.com/96688819/212421796-dd6535d9-7607-4343-ab61-7a2e8015272b.png)
as you see, in the error page card it tells users to make a issue in this github repository. This can be misleading for some users because they just go straight ahead fileing a issue instead of searching all pass issues.

i used the keyword "https://tiny.one/readme-stats" to search, and i found about 15 duplicate issues all because of PAT limit and the error card was shown, telling users to file a issue here.
![pic](https://user-images.githubusercontent.com/85282140/233851938-aae3aaea-1b13-4fc7-9904-ba53ca08cf7b.png)

### Describe the solution you'd like

Instead of telling users to file a issue straight, i think we should refer them to a documentation/wiki page that includes most of the common errors and their fixes. Then in that page, mention if non of the above fixes your issue, then go ahead and file a issue.

### Describe alternatives you've considered

easy alternative will be just charging https://tiny.one/readme-stats redirect link to readme and change "file an issue" to "check readme.md"

### Additional context

N/A

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.