Skip to content

Migrating mdbook -> zenzical #2573

@CommanderStorm

Description

@CommanderStorm

Our docs currently are fairly barebones and without much visual appeal.

Comparing this with some of the other projects under the maplibre umbrella, I think we can do a lot better and make our live simpler as well:

zensical mdbook
Image Image
https://maplibre.org/maplibre-tile-spec/ https://maplibre.org/martin/

Migrating this should be fairly simple:

  • change the config file from mdbook -> zensical
  • fix file imports #include
  • fix tabs
  • fix admoniations (those [!NOTE]-things)

One of the things that we would need to figure out on this migration is if we can keep at least redirects to the new content.
If not, that would be unfortunate, since this means that old stackoverflow posts don't link well.
Since the zensical comes with a much better linking and search subsystem, I am not super concearned, but @nyurik likely will be a lot more picky on that one.

Maybe redirecting is easy and we can add something like this, but I would also be open to doing a breaking docs change to have much improved docs.

<!DOCTYPE html>
<html>
  <head>
    <meta http-equiv="refresh" content="0;url=/new/" />
    <link rel="canonical" href="/new/" />
  </head>
</html>

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions