Skip to content

Diagrams in documentation` #201

Description

@rwb27

There are a few places where some diagrams might be helpful. For example, we could illustrate our specific flow of HTTP messages, and possibly show the relationship between different bits of LabThings a bit more visually too. I suspect Mermaid would do a nice job of this, and I believe it integrates into Sphinx.

It would be nice to add some diagrams, particularly of the HTTP communication. While we do our best to follow the WoT standard, said standard allows a fair bit of wiggle room in the "protocol binding" so it would be useful to be clear about how we are currently implementing it.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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