docs: clarify that marimo run hides source code by default#9529
Open
Light2Dark wants to merge 2 commits into
Open
docs: clarify that marimo run hides source code by default#9529Light2Dark wants to merge 2 commits into
Light2Dark wants to merge 2 commits into
Conversation
Closes #9489. Updates the deploying guide, landing page, and --include-code CLI help to make it explicit that notebook source code is not sent to the browser unless --include-code is passed. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
No issues found across 3 files
Architecture diagram
sequenceDiagram
participant User as End User (Browser)
participant MarimoRun as marimo run (Server)
participant Config as --include-code Flag
participant Notebook as Notebook Source (.py)
Note over User,Notebook: Default Deployment Flow (documented behavior)
User->>MarimoRun: HTTP GET /app-page
MarimoRun->>Config: Check --include-code flag
alt Default (--include-code not set)
Config-->>MarimoRun: false
MarimoRun->>Notebook: Execute notebook (server-side)
MarimoRun-->>User: Send rendered output HTML (NO source code)
Note over User,MarimoRun: Viewer cannot read code via browser dev tools
else --include-code flag set
Config-->>MarimoRun: true
MarimoRun->>Notebook: Execute notebook (server-side)
MarimoRun-->>User: Send rendered output + source code
end
Note over User,Notebook: CLI help text provides guidance
User->>MarimoRun: marimo run --help
MarimoRun-->>User: Shows updated description of --include-code flag
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates user-facing documentation and CLI help text to clarify that marimo run does not send notebook source code to the browser by default, making the default “hidden code” behavior a transport-level guarantee (not merely a UI restriction).
Changes:
- Expands the deploying guide to explicitly state that notebook source code is not sent to the client by default (and explains the role of
--include-code). - Rewords the docs landing page to explain “hidden and uneditable” as a consequence of the source not reaching the browser by default.
- Updates
marimo run --include-codehelp text to describe both what the flag does and what the default behavior is.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
marimo/_cli/cli.py |
Refines --include-code help text to explain client-side source availability and the default behavior. |
docs/index.md |
Clarifies the quickstart “Run apps” description to reflect that source is not sent by default. |
docs/guides/deploying/index.md |
Expands deployment guidance to explain default source-code non-exposure and when to use --include-code. |
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
📝 Summary
Closes #9489.
Clarifies in three places that
marimo rundoes not send notebook source code to the browser by default:docs/guides/deploying/index.md: expands the "Including code in your application" section to state that the default makesmarimo runsuitable for deploying notebooks with confidential source code, and that viewers cannot read it via browser dev tools.docs/index.md: rewords the landing page so "hidden and uneditable" is explained by the source not being sent to the browser, rather than implying a UI-only restriction.marimo/_cli/cli.py: updates the--include-codeflag help text to describe both the effect of the flag and the default behavior.No behavior change; documentation/help-text only.
📋 Pre-Review Checklist
✅ Merge Checklist