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

Consolidate documentation #903

Open
almet opened this issue Aug 29, 2024 · 0 comments
Open

Consolidate documentation #903

almet opened this issue Aug 29, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@almet
Copy link
Contributor

almet commented Aug 29, 2024

Currently, the documentation lives within markdown files on different parts of the repository.

This has the advantage of being simple, but makes it harder to search, and sometimes I have trouble finding the information I'm looking for.

Maybe we could have a sphinx / mkdocs tool in place which would compile all this documentation and make it available somewhere, maybe making it available at https://docs.dangerzone.rocks

I see the following advantages:

  • The doc will be easier to search
  • As part of this effort, we could create an index of our documentation
  • We could add some documentation, for instance to help newcomers contribute to the project.
@almet almet added the documentation Improvements or additions to documentation label Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant