documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Documentation using mkdocs

Open adhadse opened this issue 2 years ago • 2 comments

:wave: I did some awesome work for the Pelias project and would love for everyone to have a look at it and provide feedback.

Coming from Issue 899 this PR is intended as a proposal to merge Documentation and site hosted at pelias.io into one providing convenient experience for user searching documentation and good branded Pelias website.

Since the two repos are currently different (this repo and pelias, consider this PR as draft.

Many popular packages make sure the documentation and their landing page are on same website.


Here's the reason for this change :rocket:

Fixes pelias/pelias#899

Here's what actually got changed :clap:

  • [x] Documentation and site combined with Pelias branding
  • [X] documentation using mkdocs-material
  • [x] CI to automatically update

Here's how others can test the changes :eyes:

There is a requirements.txt file, create a venv Python3 virtual environment, activate it, and run mkdocs serve.

Or simply visit: https://pelias-demo-unaffiliated.adhadse.com/ which is temporarily hosted and will be taken down once this proposal finishes.

Man doesn't it look fantastic with Pelias branding? image

Tagging @orangejulius, @missinglink

adhadse avatar Apr 16 '23 01:04 adhadse

Wow this looks great, I'll have a closer look next week 👍

missinglink avatar Apr 16 '23 11:04 missinglink

Hi @adhadse, Absoutely, this does look great and clearly took a lot of work. Really appreciate you including all the little details like CI, and for including a hosted demo so we can see the final result.

I think @missinglink and I would have to take a look over things, and then ideally we'd help you generate a final PR against github.com/pelias/pelias. Finally we'd make a PR setting up redirects for all the documentation pages in github.com/pelias/documentation.

orangejulius avatar Apr 17 '23 17:04 orangejulius