search

drogonframework / drogon

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

Documentation is missing #1479

Closed kamikaze closed 6 months ago

kamikaze commented 1 year ago

Documentation at https://drogon.org/ is missing, url is broken

chuckn408 commented 1 year ago

It appears to be there now https://imgur.com/a/Ays7qWE

LynxesExe commented 1 year ago

What happened to DocsForge? It offered a much better experience, and the commenting section allowed to ask and answer to questions related to the page. It was also a way to discuss improvements for the documentation itself before opening an issue here on github...

Is there anyway to bring DocsForge back or at least a better alternative than the wiki?

This framework has proven great for me, but with the wiki it's much harder to use. Maybe it's just me of course.

an-tao commented 1 year ago

The owner of DocsForge shut it down, I have contacted him and he said he is considering releasing the source code, I am waiting for further news

LynxesExe commented 1 year ago

I understand, that is quite sad. Fortunately, I have found that Drogon is intuitive enough to the point where usually just using the IDE is enough to get by for basic tasks. Maybe the usage of a tool like MkDocs could be considered to create a static website to host the docs? Possibly using the github.io website feature.

It most likely won't have the commenting feature, which would be nice, but it would still be better than the Wiki in my opinion.

Of course, documentation takes a lot of effort, but it's worth in the end, I guess let's wait for the owner of DocsForge to reply first.

rickiewars commented 1 year ago

I opened an issue previously about Docsforge being down and posted an update on that issue. Here is the update for quick reference.

Original issue: #1460

Hi all, I forked the Drogon-docs repo and added some files and configurations to render the markdown using Docsify. The documentation is served at an Github Pages site.

If DrogonFramework is interested in using Docsify for serving their documentation, I'll be glad to make a pull-request at the Drogon-Docs repo, just notify me.

rickiewars commented 1 year ago

Issue can be closed because a replacement has been merged in pull-request drogonframework/drogon-docs#57