Use mdbook for documentation (fixes #375) #9

nutomic · 2019-12-31T14:35:07Z

nutomic commented

2019-12-31 14:35:07 +00:00

I basically moved all the documentation out of the readme, and into the docs folder, in a format that can be used by mdbook. See here for documentation on how this can be used.

What's left to do is throw the output of mdbook build docs/ (generated under docs/book/) onto some server (its all static files). For now its probably fine to do this manually, but we could also setup a CI task. We also need to add a link to the documentation in the readme.

I basically moved all the documentation out of the readme, and into the docs folder, in a format that can be used by mdbook. [See here for documentation on how this can be used](https://rust-lang.github.io/mdBook/index.html). What's left to do is throw the output of `mdbook build docs/` (generated under `docs/book/`) onto some server (its all static files). For now its probably fine to do this manually, but we could also setup a CI task. We also need to add a link to the documentation in the readme.

Screenshot_2019-12-31 About - Lemmy Documentation.png

141 KiB

nutomic commented

2020-01-01 17:15:24 +00:00

Moved translation docs back to readme, and copied install docs in both places like we said.

I also updated the x86 Dockerfile to include docs with the image. I dont have any way to build the Docker images for other architectures, so I left those alone.

Moved translation docs back to readme, and copied install docs in both places like we said. I also updated the x86 Dockerfile to include docs with the image. I dont have any way to build the Docker images for other architectures, so I left those alone.

nutomic commented

2020-01-01 17:23:33 +00:00

We also need to add links to the documentation both in the readme and in the Lemmy frontend.