Skip to content
This repository was archived by the owner on Nov 25, 2021. It is now read-only.
This repository was archived by the owner on Nov 25, 2021. It is now read-only.

Add mermaid diagram to README #8

@felixfbecker

Description

@felixfbecker

I took a stab at modelling the current and desired state so we can include it in the README:

graph LR
  State --> CodeView[Code view]
  CodeView --renders with state--> HoverOverlay
  CodeView --passes events--> locateTarget
  subgraph Hoverifier
  locateTarget --> fetching[Hover and Definition Fetching]
  fetching --> State
  end
Loading
graph LR
  State --> CodeView[Code view]
  CodeView --renders with state--> HoverOverlay
  HoverOverlay --> Highlight[Highlight box]
  CodeView --passes events--> PositionLogic[Position logic]
  PositionLogic --returns positions--> CodeView
  CodeView --passes positions--> fetching[Hover and Definition Fetching]
  subgraph State Management
  fetching --> State
  end
Loading

@ijsnow are these accurate?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions