Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
evan-palmer opened this issue Mar 2, 2023 · 0 comments
Open

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

evan-palmer opened this issue Mar 2, 2023 · 0 comments
Labels
enhancement New feature or request needs triage This issue needs triage support

Comments

@evan-palmer
Copy link
Collaborator

evan-palmer commented Mar 2, 2023

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

@evan-palmer evan-palmer added the enhancement New feature or request label Mar 2, 2023
@evan-palmer evan-palmer added the low priority This is a low priority issue label Mar 31, 2023
@evan-palmer evan-palmer added needs triage This issue needs triage support and removed low priority This is a low priority issue labels Aug 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs triage This issue needs triage support
Projects
None yet
Development

No branches or pull requests

1 participant