educational-technology-collective / jupyterlab-pioneer

A JupyterLab extension for generating and exporting JupyterLab event telemetry data.
https://jupyterlab-pioneer.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
12 stars 2 forks source link

Need a high level architecture doc #8

Closed cab938 closed 11 months ago

cab938 commented 1 year ago

This doesn't need to go in the README if you think it distracts! But I would like to see a high level architecture document somewhere (perhaps in docs/architecture.md?). It should introduce the terms router, event, exporter at the very least. It should show the boundary between the browser and the python kernel. It should introduce the basic set of events we have in the system, and the basic set of exporters, but doesn't have to go into detail about them.