Conversation
- removed syscalls page
GabrielaReyna
left a comment
GabrielaReyna
left a comment
There was a problem hiding this comment.
Overall looks good to me. I would only advice to not abuse the use of bullet points in the overview page. Almost all sections are entirely bullet points, and the lists are long and difficult to read.
I left comments on two of the subsections with potential solutions.
| title: BrowserPod | ||
| shortTitle: Overview | ||
| description: Run sandboxed backend services directly in a client browser's tab. | ||
| description: A universal execution layer for running code safely in the browser |
There was a problem hiding this comment.
| description: A universal execution layer for running code safely in the browser | |
| description: A universal execution layer for running code safely in the browser sandbox |
| - **Enable education at scale**: Provide high-fidelity learning environments with minimal operational overhead. Eliminate per-student sandbox costs to make hands-on education economically feasible at scale. | ||
| - **Process sensitive data locally**: Keep user inputs and outputs in the browser by default, enabling privacy-first applications and removing jurisdictional risks associated with cloud data transfer. | ||
|
|
||
| ## Why pick the BrowserPod API? |
There was a problem hiding this comment.
This section's bullet points can be re-shaped by using subheadings (###) instead of the list. An idea is to group similar topics into one subheading and make the content one to two short paragraphs.
For example, latency and portals could be a single subtopic (name it as you feel it) given both talk about no network trips and meeting the user where they are. Economics its a substantial topic already. Security is another substancial subtopic. Etc.
| - **Multi-language by design**: BrowserPod is architected from the ground up as a language-agnostic execution platform. While it launches with Node.js, its Linux-compliant foundation supports any runtime—Python, Ruby, Go, Rust, and eventually full Linux containers—rather than being constrained to a single ecosystem. | ||
| - **Portals**: Share working applications instantly via secure, temporary URLs. Enable live previews, collaborative troubleshooting, and interactive demos without standing up dedicated infrastructure. | ||
|
|
||
| ## How it works (high level) |
There was a problem hiding this comment.
This section is also hard to follow as un-numbered bullet points list.
We have two options here:
- Make the bullet points a numbered list, where you explain the user the step by step of how browserpod works and how the different parts connect to each other. The numers help the user follow a sequence. It is hard to tell if you are using the bulletpoints as a sequence, or as separate components of the browserpod architecture.
- Make it plain text (2-3 short paragraps) where you tell the story of how it works.
I can also see adding the technical graphic, here or on a more detailed page of how browserpod works.
There was a problem hiding this comment.
I am talking about the graphic in this post: https://labs.leaningtech.com/blog/browserpod-10
2 participants
Another pass at the BP docs. Still due from our 1.0 release. To bring the language and direction a bit more in line with our release blog post etc.
Changes:
Getting started: Minor intro improvements for clarity