drogon icon indicating copy to clipboard operation
drogon copied to clipboard

README.md should include link to documentation

Open alandefreitas opened this issue 2 years ago • 3 comments

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.

alandefreitas avatar Sep 15 '23 13:09 alandefreitas

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 avatar Sep 19 '23 08:09 rbugajewski

Subtasks:

  • [ ] Redesign website header to make documentation link more prominent
  • [ ] Add documentation reference to README

rbugajewski avatar Sep 19 '23 08:09 rbugajewski

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

KlotzAndrew avatar Jun 25 '24 20:06 KlotzAndrew