Skip to content

Update doc snippets to reflect fully working examples #723

Description

@chiphogg

An external user gave feedback that they prefer seeing fully functional code snippets in docs: all #includes, using statements, etc. that we would need to get an example working.

I think this deserves a dedicated pass over the documentation, and an explicit design for how we would balance that need with the goal of being concise and letting the structure show through. We might have two versions; we might just update all samples to be fully working; we might have a section at the top (or a collapsed section) that gives the right includes; I don't know. This deserves a brainstorming session and an evaluation of our options.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions