Coder Social home page Coder Social logo

Comments (2)

jtpio avatar jtpio commented on June 17, 2024

Thanks @telamonian.

Yes for now there is one in this temp gist: https://gist.github.com/jtpio/3763af75ec8cd7bfdce86501563fef09

But it could be improved and other diagrams covering different parts could also be added (https://github.com/jtpio/jupyterlite/issues/34).

from jupyterlite.

bollwyvl avatar bollwyvl commented on June 17, 2024

So... as a systems enginerd, i love building diagrams (obviously) but having them purely for documentation means they get out of date almost immediately. Over on jupyterlab-lsp, we spent a bunch of effort getting them set up, but then I have shamefully been really bad at updating them while @krassowski goes off and builds 🔥 stuff. And graphviz is barely fit for purpose in this case. ipydrawio (which i want REAAAALY BADLY in jupyterlite) is better at both being a diagram and being a model. The reason I haven't PRd the initial (or any other) diagram from #34 yet is I need to think real hard about how to keep them accurate and get real value out of that model.

Another challenge we have is this architecture is best described as a delta from a reference architecture (pip -> @jupyterlab/application-top -> jupyterlab -> jupyter_server), for which there are no systems models.

Anyhow, onto testability: the initial chartjunk of ls packages/*/package.json apps/*/package.json is relatively easy, as we can check the symmetric difference of the labels without even understanding the underlying XML very much. So I can probably get something out pretty quick that would keep this up-to-date, and add ipydrawio to the docs/binder environment, and deal with dumb-old-regexen or stdlib xml parsing and xpath to be more precise.

An area of (sometimes-funded) research is turning visual representations into executable test cases #6. For example, #79, that's a relatively complex sequence diagram involving multiple re-entrance to a browser session... and it might not make that great of an explainer, aside from showing that multiple apps can reuse the contents manager.

from jupyterlite.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.