Skip to content

docs: clarify html_head_file is run-mode only (troubleshooting)#10220

Open
Bartok9 wants to merge 2 commits into
marimo-team:mainfrom
Bartok9:top10/docs-html-head-run-mode
Open

docs: clarify html_head_file is run-mode only (troubleshooting)#10220
Bartok9 wants to merge 2 commits into
marimo-team:mainfrom
Bartok9:top10/docs-html-head-run-mode

Conversation

@Bartok9

@Bartok9 Bartok9 commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

This pull request was AI-assisted; human-reviewed.

Why

Users hit #9298 believing html_head_file arbitrarily stopped injecting scripts. The injection path is gated to run mode on purpose (edit mode blocks arbitrary head scripts). The guide had a short note; it was easy to miss when verifying under marimo edit.

What

  • Promote run-mode-only note to a warning that names the security rationale
  • Add a Troubleshooting section: run vs edit, relative paths, hard reload, minimal console.log check
  • Point at css_file for edit-time styling

Addresses #9298 (docs clarification; leaves a true RUN-mode-only regression as a follow-up if still observed).

I have read the CLA Document and I hereby sign the CLA

@Bartok9
Bartok9 requested a review from akshayka as a code owner July 17, 2026 22:54
@vercel

vercel Bot commented Jul 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
marimo-docs Ready Ready Preview, Comment Jul 20, 2026 11:28pm

Request Review

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 17, 2026
@Bartok9

Bartok9 commented Jul 17, 2026

Copy link
Copy Markdown
Contributor Author

I have read the CLA Document and I hereby sign the CLA

Comment thread docs/guides/configuration/html_head.md Outdated
Comment thread docs/guides/configuration/html_head.md Outdated
Comment thread docs/guides/configuration/html_head.md Outdated
Comment thread docs/guides/configuration/html_head.md Outdated
Comment thread docs/guides/configuration/html_head.md Outdated
@Bartok9

Bartok9 commented Jul 20, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review @akshayka — all addressed in dc932c4:

  • Dropped the "lifecycle regression" line entirely (superfluous/unclear).
  • Removed "(security)" from the warning title and folded the arbitrary-scripts rationale into the warning body.
  • Deleted the redundant "That behavior ..." sentence.
  • Moved Troubleshooting to the bottom of the page, removed the ": "My script ..."" suffix from the heading, and added a lead-in sentence explaining what it's for.

@Bartok9

Bartok9 commented Jul 22, 2026

Copy link
Copy Markdown
Contributor Author

@akshayka — feedback from your review should all be in dc932c47e (resolved threads: dropped lifecycle line / (security) suffix / redundant “That behavior…”, moved Troubleshooting to the bottom with an intro sentence, removed the : "My script…" suffix). Ready for another look when you have a moment. Thanks!

@Bartok9

Bartok9 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @akshayka — the July 20 review notes should all be reflected on the latest tip (dc932c4): warning trimmed, redundant lines removed, troubleshooting intro sentence + section at bottom of the page. Happy to tweak further if anything still feels off.

@kirangadhave
kirangadhave requested a review from akshayka July 24, 2026 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants