You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
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:
Additional context
This came up in #145 (comment) and #147
The text was updated successfully, but these errors were encountered: