Documentation not accessible

BeWelcome / rox

:earth_africa: BeWelcome lets you share a place to stay, connect with travellers, meet up and find accommodation on your journey. It is and will always be a free, open source, non for profit, democratic community.

https://www.bewelcome.org

GNU General Public License v2.0

188 stars 54 forks source link

Documentation not accessible #296

Closed tillwenke closed 9 months ago

tillwenke commented 2 years ago

"Doc tree" https://github.com/BeWelcome/rox/blob/develop/doc/book returns 404. And (thus?) compiling with mkdocs also does not work (under Ubuntu 22). ~ to be found in README

thisismeonmounteverest commented 2 years ago

@TillWenke Yes, that is unfortunately true. I removed the files 5 years ago when the project was migrated to full symfony and not a weird mix of laravel and symfony.

I try to bring some documentation back. Probably needed to start working on the right stuff.

tillwenke commented 2 years ago

Hi, could you provide a hotfix (google drive whatever) - without doc it seem hard to start :)

thisismeonmounteverest commented 2 years ago

The last commit readded the missing files and you can generate docs again. But the files are outdated, so another update will be needed to get you started.

For starters:

Code is based on Symfony with Doctrine and is organized accordingly.
There is a lot of old code that still needs to be migrated below the build.
Docker setup should get you started with a test environment quickly.

tillwenke commented 2 years ago

appreciate it

thisismeonmounteverest commented 2 years ago

Updated some more. Please let me know if you need more information.