Skip to content
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

docs: user count not updated correctly #667

Open
yehiarasheed opened this issue Oct 7, 2024 · 0 comments
Open

docs: user count not updated correctly #667

yehiarasheed opened this issue Oct 7, 2024 · 0 comments

Comments

@yehiarasheed
Copy link
Contributor

yehiarasheed commented Oct 7, 2024

Description

While I was reading the project's README.md page, I realized that under the What is this? section, there is the sentence

Over 500,000 people have benefitted from this handbook!

Upon checking the website's home page (preface), I found the heading

Fastest way to prepare effectively for your software engineering interviews, used by over 1,000,000 engineers

under the What is this section as well as the heading

Over 1,000,000 people have benefitted from this handbook!

right below it (Check the screenshots below for more clarity on this issue). Therefore, assuming that this number has already been fact-checked since it has been used twice on the website (correct me if I'm wrong), then it should be changed to the same number as well in the README.md file as well. I will follow up on this issue with a PR correcting the docs.

It is also worth mentioning that the algolia search tool on the website itself contains old information, I'm assuming that it doesn't reindex the website regularly upon making changes to the website. I think this could be fixed during deployment if we can manually turn on indexing for changed pages on the website. Could create an issue for it and work on it as needed, more on this in the screenshot below. I also thought of adding a section under the Over 1,000,000 people have benefitted from this handbook! heading mentioned earlier for people to add testimonials about how the handbook has helped them, just like the one added under the Success stories section by opening a pull request and so on. Ultimately encouraging more people to participate and showing users how helpful this handbook could be, again would be done in a separate issue.

Screenshots

README

image

Website

image
image

Search issue

image
Note that this text is actually non-existent on the website itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant