Skip to content

documenting self-contained examples #3501

@d-v-b

Description

@d-v-b

We should have a dedicated section in our docs page for the self-contained examples in the examples folder.
We should also ensure that these examples are self-documenting as much as possible, and I think the best solution there is to put each example in its own directory, and to include a README.md file along with the source code. The content of the readme can be re-used in our rendered docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions