Skip to content
This repository was archived by the owner on Apr 10, 2025. It is now read-only.
This repository was archived by the owner on Apr 10, 2025. It is now read-only.

[FEATURE]: Host user documentation using Github Pages #14

@evan-palmer

Description

@evan-palmer

Is your feature request related to a problem? Please describe

There is currently no user documentation introducing the project or how to use it.

Describe the solution you'd like

Create a user documentation website that describes how to use the project. If possible, it may be worth embedding the developer documentation into the site as well. However, if the theme of choice is not compatible with Doxygen, then the two should be kept separate.

Describe alternatives you've considered

The user documentation could be embedded directly into the README. However, this would make the README difficult to approach and would reduce project exposure.

Implementation Ideas

The easiest approach to developing the documentation site would be to use Sphinx with Github Pages. Alternatively, Gitbooks provides a nice interface for documentation and has free support for open source projects.

Additional context

Gitbook

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestneeds triageThis issue needs triage support

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions