drogonframework / drogon

Drogon: A C++14/17/20 based HTTP web application framework running on Linux/macOS/Unix/Windows
MIT License
11.61k stars 1.12k forks source link

README.md should include link to documentation #1780

Open alandefreitas opened 1 year ago

alandefreitas commented 1 year ago

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

When I was getting started I looked for the website with the documentation on the main page but couldn't find it. I had to google it to find https://drogon.org/ and https://drogonframework.github.io/drogon-docs. I was still confused thinking one of them was unmaintained until I noticed the "docs" link in the drogon.org navbar links to the same https://drogonframework.github.io/drogon-docs.

Describe the solution you'd like

The website would be included on the main page and on the project sidebar. A person searching (ctrl + f) for "documentation" would find it.

Describe alternatives you've considered

Googling it, which is suboptimal/incompatible for a project as good as this.

rbugajewski commented 1 year ago

Thanks for the feedback, and sorry for the bad first experience you had to go through. I hope that you still like the project and that it helps you get things done.

I completely agree that we should make links to the documentation more prominent.

rbugajewski commented 1 year ago

Subtasks:

KlotzAndrew commented 4 months ago

I also trying to google around for the docs. It looks like they return a 404 now (using this link: https://drogonframework.github.io/drogon-docs)

Screenshot 2024-06-25 at 4 17 19 PM