Skip to content

Add a tutorial explaining how to contribute documentation #148

Open
@chapulina

Description

@chapulina

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or requesthelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions