chore: Switch docs config from sphinx to mkdocs

[setu4993]

This PR is a full revamp of the docs for Protect to use mkdocs from sphinx. It allows us to use markdown, while also exposing a bunch of helpers and functions from galileo-core inline as we wanted to, while being more searchable, easier to write and maintain.

Changes:

• feat: Update docs from Sphinx => mkdocs
• chore: Ignore mkdocs auto
• feat: Configure mkdocs
• ci: Update docs build process
• ci: Fix path for GH pages config
• chore(deps): Switch to mkdocs
• ci: Include CNAME in docs dir

I cheated and deployed it already. Go see example: https://protect.docs.rungalileo.io/

[franz101]

The mk docs look really amazing, the only issue right now I have there is no way to search across different tools. Mainly from a user perspective searching for a function on https://docs.rungalileo.io won't lead to protect.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.88%. Comparing base (057ce63) to head (a58477b).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #42   +/-   ##
=======================================
  Coverage   63.88%   63.88%           
=======================================
  Files           2        2           
  Lines         108      108           
=======================================
  Hits           69       69           
  Misses         39       39           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[setu4993]

The mk docs look really amazing, the only issue right now I have there is no way to search across different tools. Mainly from a user perspective searching for a function on https://docs.rungalileo.io won't lead to protect.

True, but that's tangential. It doesn't change the status quo, but it does in fact gets us closer to being able to change it because we can migrate docs to use mkdocs instead of GitBook.

[franz101]

Curious, Is this the plan to move off git books (from product side)?

[setu4993]

Curious, Is this the plan to move off git books (from product side)?

From what I talked to Quique: We are open to it and not tied to GitBook if we don't have to do a ton of work and get clear benefits. I'll experiment with bringing all API docs alongside actual docs from our other libraries in a couple weeks to see if we can get to something nicer with mkdocs.