Skip to content

[Chore] Rebuilding the documentation for simplicity #378

Description

@spron-in

What needs to be done?

This is a large effort (epic/project level) rather than a simple task.

Right now, our documentation relies on mkdocs. The way it works is that we store the documentation in the everest-doc repo across various branches. Then, in the openeverest.github.io repo, we run a hackish script that builds the docs and dumps plain HTML files into the website's openeverest.io/documentation folder.

This setup is too complex and prone to errors.

Ideally, we want to rework the documentation to use something more modern, like Docusaurus. We'd like to serve it directly from GitHub Pages and have a proper version picker in place.

Additional suggestions or changes to the overall documentation structure are also welcome.

Why is this needed?

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions