Skip to content

[Enhancement]: Add documentation package and host on ReadTheDocs #186

@tomvothecoder

Description

@tomvothecoder

Is your feature request related to a problem?

The documentation pages are stored in https://github.com/E3SM-Project/simboard/tree/main/docs, but they are not built by a documentation package like mkdocs or hosted on a platform like ReadTheDocs.

Hosting the developer docs will make accessibility and onboarding easier.

Describe the solution you'd like

  • Add mkdocs to the backend uv requirements
  • Link ReadTheDocs with config file

Describe alternatives you've considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions