fix(web): stop shipping doc-comments in web/index.html to every visitor #953

Merged
brenno merged 1 commit from fix/index-html-comment-leak into main 2026-07-29 08:33:10 +00:00
Owner

web/index.html is copied verbatim into the web build, so its HTML comments travel to anyone who views the deployed page's source. The CSP/referrer/splash explanations there had grown into full documentation blocks duplicating (or exceeding) what's already in docs/SECURITY_DESIGN.md and docs/BUILD.md.

This trims those comments to short pointers and moves the actual rationale into those docs, where it serves maintainers instead of every browser tab.

Verified:

  • flutter test test/web_index_splash_test.dart test/pack_web_release_test.dart test/web_htaccess_headers_test.dart — green
  • full make check — green (6825 tests, no code changes, docs/HTML only)
  • make check-comment-language — green

No regression test added: this is a comment/documentation-only change with no functional behavior to regress (the existing web_index_splash_test.dart already guards the splash layer's actual behavior).

Reported by Jeroen Diel. Closes #952.

web/index.html is copied verbatim into the web build, so its HTML comments travel to anyone who views the deployed page's source. The CSP/referrer/splash explanations there had grown into full documentation blocks duplicating (or exceeding) what's already in docs/SECURITY_DESIGN.md and docs/BUILD.md. This trims those comments to short pointers and moves the actual rationale into those docs, where it serves maintainers instead of every browser tab. Verified: - flutter test test/web_index_splash_test.dart test/pack_web_release_test.dart test/web_htaccess_headers_test.dart — green - full make check — green (6825 tests, no code changes, docs/HTML only) - make check-comment-language — green No regression test added: this is a comment/documentation-only change with no functional behavior to regress (the existing web_index_splash_test.dart already guards the splash layer's actual behavior). Reported by Jeroen Diel. Closes #952.
fix(web): stop shipping doc-comments in web/index.html to every visitor
All checks were successful
scans / scans (pull_request) Successful in 3m15s
7fbc3509ca
web/index.html is copied verbatim into the web build, so its HTML comments
travel to anyone who views the deployed page's source. The CSP/referrer/splash
explanations there had grown into full documentation blocks duplicating (or
exceeding) what's in docs/SECURITY_DESIGN.md and docs/BUILD.md. Trim them to
short pointers and move the actual rationale into those docs, where it serves
maintainers instead of every browser tab.

Reported by Jeroen Diel. Closes #952.
brenno merged commit 1ea4d2190a into main 2026-07-29 08:33:10 +00:00
Sign in to join this conversation.
No description provided.