-
Notifications
You must be signed in to change notification settings - Fork 19
Bp docs language tweaks #369
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
codingfrog27
wants to merge
4
commits into
main
Choose a base branch
from
BP-docs-language-tweaks
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
756db89
initial tweaking (needs extra review)
codingfrog27 b64eaa3
toning down Ai language a tiny bit and added multi language support a…
codingfrog27 fb55b27
first overview restructure
codingfrog27 284e095
second pass making the pass more consise. Added first pass as alt pag…
codingfrog27 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
sites/browserpod/src/content/docs/01-alt_fluffier_overview.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I like this overview better |
||
| title: BrowserPod | ||
| shortTitle: Overview | ||
| description: A universal execution layer for running code safely in the browser | ||
| --- | ||
|
|
||
| import LinkButton from "@leaningtech/astro-theme/components/LinkButton.astro"; | ||
| import { DISCORD_URL } from "@/consts.ts"; | ||
|
|
||
| <div class="%BP_LATEST%" /> | ||
|
|
||
| <div class="not-prose flex gap-2 mb-2"> | ||
| <img src="https://img.shields.io/badge/version-%BP_LATEST%-orange" alt="Version %BP_LATEST%" /> | ||
| <a href="https://discord.leaningtech.com/"> | ||
| <img src="https://img.shields.io/discord/988743885121548329?color=%237289DA&logo=discord&logoColor=ffffff" alt="Discord server" /> | ||
| </a> | ||
| <a href="https://github.com/leaningtech/browserpod-meta/issues"> | ||
| <img src="https://img.shields.io/github/issues/leaningtech/browserpod-meta.svg?logo=github" alt="GitHub issues" /> | ||
| </a> | ||
| </div> | ||
|
|
||
| **BrowserPod** is a universal execution layer for browser-based compute. It provides a sandboxed runtime API that enables client browsers to host full runtimes—compiled to WebAssembly (Wasm)—with near-native performance. | ||
|
|
||
| Instead of provisioning costly cloud servers, BrowserPod allows you to execute full-stack workloads directly within the user's browser tab. Each **pod** is ephemeral, constrained by the browser's security model, and isolated from the host operating system via a dedicated syscall layer. | ||
|
|
||
| <div class="m-4 flex justify-center"> | ||
| [Get started](/docs/getting-started/quickstart) · [Basic Tutorial](/docs/getting-started/expressjs) · [API reference](/docs/reference) · [GitHub repository](https://github.com/leaningtech/browserpod-meta) · [Licensing](/docs/more/licensing) | ||
| </div> | ||
|
|
||
| ## The Shift: Moving Compute to the Client | ||
|
|
||
| Traditional sandboxed environments rely on cloud-side virtualization. While effective, this model introduces recurring infrastructure costs, network latency, and data privacy complexities. | ||
|
|
||
| **BrowserPod flips the economics of code execution.** By leveraging the user's local CPU and the browser's security model, you eliminate per-session infrastructure overhead. This makes it financially viable to scale applications—like AI code interpreters or interactive coding platforms—to millions of users without the linear growth of a cloud bill. | ||
|
|
||
| ## Use Cases | ||
|
|
||
| ### **Development Tools & Interactive Content** | ||
| BrowserPod is built to power the next generation of web-based IDEs and full-stack development environments. By supporting package installs, dev servers, and build tools with high fidelity, it allows developers to create "real" workflows in the browser. This extends to documentation and live demos, where you can turn static examples into runnable environments that users can modify and execute without leaving the page. | ||
|
|
||
| ### **Safe Execution of Untrusted Code** | ||
| Whether you are running AI-generated code, user scripts, or agent-assembled programs, BrowserPod provides a secure sandbox with zero "cold start" latency. Because execution happens on the client side, you tighten security boundaries by keeping sensitive data within the user's local environment. | ||
|
|
||
| ### **Privacy-First Applications and Education** | ||
| By keeping inputs and outputs on the user's device, BrowserPod enables privacy-conscious applications that bypass the jurisdictional risks of cloud data transfer. For educators, this model removes the operational burden of managing per-student sandboxes, making hands-on technical education economically feasible at any scale. | ||
|
|
||
| ## How it works | ||
|
|
||
|  | ||
|
|
||
| To understand how BrowserPod achieves high-fidelity behavior in a browser, it helps to look at the execution flow: | ||
|
|
||
| 1. **Runtime Loading:** BrowserPod delivers complete runtime engines (starting with Node.js) compiled to WebAssembly. These engines target a Linux-compliant syscall interface rather than a limited JavaScript shim. | ||
| 2. **Execution:** The browser’s JavaScript engine executes the Wasm-compiled runtime using WebWorkers for true multi-threading and process isolation. This allows for complex, multi-process workloads that would normally require a full OS. | ||
| 3. **Resource Virtualization:** A block-based streaming virtual filesystem provides full POSIX compatibility. Disk images are streamed on-demand, and any file changes stay local to the browser session. | ||
| 4. **Networking via Portals:** When a service inside the pod listens on a port, BrowserPod automatically creates a **Portal**. This secure URL routes external traffic directly to the service running in the browser, enabling live previews and collaboration without any backend servers. | ||
|
|
||
| ## Roadmap | ||
|
|
||
| BrowserPod currently supports **Node.js**. Our goal is to expand this into a language-agnostic platform throughout 2026, with planned milestones across the year: | ||
|
|
||
| * Command-line tools (bash, git, coreutils), followed by **Python** and **Ruby** support. | ||
| * Support for **Go** and **Rust** engines. | ||
| * **Linux-class workloads** powered by CheerpX, enabling any unmodified Linux container to run in the browser. | ||
|
|
||
| ## Community and Support | ||
|
|
||
| <LinkButton | ||
| type="discord" | ||
| href={DISCORD_URL} | ||
| iconLeft="fa-brands:discord" | ||
| label="Join our Discord server" | ||
| /> | ||
|
|
||
| <LinkButton | ||
| type="secondary" | ||
| href="https://twitter.com/leaningtech" | ||
| iconLeft="fa-brands:twitter" | ||
| label="Follow us on Twitter" | ||
| /> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 0 additions & 29 deletions
29
sites/browserpod/src/content/docs/11-understanding-browserpod/04-syscalls.md
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.