Skip to content

BP reference update#413

Merged
alexp-sssup merged 5 commits into
mainfrom
Browserpod-reference-updates
Jun 11, 2026
Merged

BP reference update#413
alexp-sssup merged 5 commits into
mainfrom
Browserpod-reference-updates

Conversation

@codingfrog27

@codingfrog27 codingfrog27 commented May 18, 2026

Copy link
Copy Markdown
Contributor

Feedback implemented!

For consideration

  • for the optional disk image parameter i wrote

When specified, the pod's home filesystem will point to the /home directory within this image.

Is this correct? Or does the pod's home directory point to the root of the image instead?

changes

  • added base bp handle reference page with general info
  • same for terminal and process
    • referenced these 3 where applicable
  • Documented Storagekey allowing for persitent storage
  • mentioned onopen maps to xdg-open
  • Tightened language throughout

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented May 18, 2026

Copy link
Copy Markdown

Deploying labs-browserpod-previews with  Cloudflare Pages  Cloudflare Pages

Latest commit: 8a63e63
Status: ✅  Deploy successful!
Preview URL: https://950699d4.labs-browserpod-previews.pages.dev
Branch Preview URL: https://browserpod-reference-updates.labs-browserpod-previews.pages.dev

View logs

Comment thread sites/browserpod/src/content/docs/13-reference/00-BrowserPod/00-boot.md Outdated
Comment thread sites/browserpod/src/content/docs/13-reference/00-BrowserPod/05-onOpen.md Outdated
@GabrielaReyna GabrielaReyna changed the title first draft BP reference update (first draft) May 18, 2026

@GabrielaReyna GabrielaReyna left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job documenting these!

In addition to my comments on the code, I will add some bullet points as to-do's:

  • Please document Terminal and Process, even if they are opaque or minimalistic. Please sync with Yuri and Alessandro for any questions. These are first-class, so they go at the same level as BinaryFile, TextFile etc.
  • Please add links where Terminal and Process are mentioned in the text, referring to their documented page.
  • There is a nice explanatory page for BinaryFile, this is a good chance to do something similar for BrowserPod in the reference, given an instance of BrowserPod we call it a "Pod" and it can be confusing for some users. This is an opportunity to link to this page when we call it like so.

@codingfrog27 codingfrog27 force-pushed the Browserpod-reference-updates branch from 62acc57 to 99d3aa7 Compare June 3, 2026 14:00
@codingfrog27 codingfrog27 force-pushed the Browserpod-reference-updates branch from 99d3aa7 to 0ea495b Compare June 3, 2026 14:25
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/00-boot.md Outdated
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/00-boot.md Outdated
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/05-onOpen.md Outdated
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/04-createFile.md Outdated
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/index.md Outdated
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/index.md Outdated
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/index.md Outdated
@codingfrog27 codingfrog27 changed the title BP reference update (first draft) BP reference update Jun 4, 2026
@codingfrog27 codingfrog27 force-pushed the Browserpod-reference-updates branch from 0ea495b to 4e0d460 Compare June 10, 2026 20:23
@codingfrog27

Copy link
Copy Markdown
Contributor Author

Addressed the latest review round, thanks for the review and feedback!

boot.md

  • Corrected that userimages mounts to /home of the Pod's filesystem
  • Clarified storage key

-createCustomTerminal: Dug into the code and found the type is ArrayBuffer, corrected it both here and in BP-meta

  • Various other small fixes:
    • maybe noteworthy that I made the judgement call of wording Createfiles truncation to 0 bytes when called on existing files as "will wipe its contents".
  • Extra: updated the new ephemeral mode setup in the Pod part of the glossary as well.

@codingfrog27 codingfrog27 force-pushed the Browserpod-reference-updates branch from 4e0d460 to a47c3cb Compare June 10, 2026 20:30
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/00-boot.md Outdated
Comment thread sites/browserpod/src/content/docs/14-reference/00-BrowserPod/index.md Outdated
Comment thread sites/browserpod/src/content/docs/15-more/00-glossary.md Outdated
@codingfrog27 codingfrog27 force-pushed the Browserpod-reference-updates branch from a47c3cb to 8a63e63 Compare June 11, 2026 12:29
@alexp-sssup alexp-sssup marked this pull request as ready for review June 11, 2026 12:31
@alexp-sssup alexp-sssup merged commit 4cc8455 into main Jun 11, 2026
7 checks passed
@alexp-sssup alexp-sssup deleted the Browserpod-reference-updates branch June 11, 2026 12:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants