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

Add a tutorial explaining how to contribute documentation #148

Open
chapulina opened this issue Feb 17, 2021 · 0 comments
Open

Add a tutorial explaining how to contribute documentation #148

chapulina opened this issue Feb 17, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@chapulina
Copy link
Contributor

Desired behavior

We want users to contribute documentation, but it's not always straightforward how to do it. We have some tips on generating API docs in the code contributing guide, but I think there's enough to explain about documentation to prompt its own tutorial.

Alternatives considered

We can also keep this documentation together with the code contribution docs, but I think we could at least give it more context and make it easier to find.

Implementation suggestion

Things to document:

  • How the API docs and per-library tutorials are generated using doxygen and can be tested locally (some explanation already in each install tutorial, i.e. here)
  • The fact that the API docs are deployed nightly
  • How the docs on this site are using custom code on a private repository to be generated, are deployed on demand, and can't be tested locally yet (Make it easy to view tutorials before deploying #85)

Additional context

This came up in #145 (comment) and #147

@chapulina chapulina added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Feb 17, 2021
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 enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant