NLESC-JCER / cpp2wasm

Guide to make C++ available as a web application
https://nlesc-jcer.github.io/cpp2wasm/
Apache License 2.0
22 stars 6 forks source link

Added section images #65

Closed jspaaks closed 4 years ago

jspaaks commented 4 years ago

To separate the content a bit better, I added section images. Hope you like it!

PS When making these changes, I noticed that perhaps it's good to

  1. put the Swagger web service before the Flask app
  2. make the first part of the webassembly section result in a service instead of a HTML page
jspaaks commented 4 years ago

for Python we should add pybind11 in image.

I thought "Python bindings" was a bit more generic, therefore I left it like this. Let me know if you'd still like to see it changed.

sverhoeven commented 4 years ago

for Python we should add pybind11 in image.

I thought "Python bindings" was a bit more generic, therefore I left it like this. Let me know if you'd still like to see it changed.

For consistencies sake we should have the flavor of bindings and the bindings library in both JS and Python diagrams. Or just have the flavor of bindings.

jspaaks commented 4 years ago

I think it's OK to sacrifice some consistency across the document if that makes an individual section image easier to understand. The purpose of the images is not to accurately capture all the details that are discussed in the corresponding text; rather, they provide an anchor for readers to recognize. In that role, I thought that "C++ to Python bindings" will be recognized by more readers than "pybind11".

sonarcloud[bot] commented 4 years ago

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

jspaaks commented 4 years ago

On svg v png: On GitHub everything works ok, but at least my editor (Atom) struggles with rendering order of layers, e.g. text on top of areas. png is a bit more rebust in that sense.

jspaaks commented 4 years ago

dark theme in VS code

Same in atom. I'll add a white bg in the next round of edits after #66