docs: add webmaster instructions the single-file html#305
Open
joanise wants to merge 2 commits into
Open
Conversation
|
Review changes with |
Contributor
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #305 +/- ##
=======================================
Coverage 93.76% 93.76%
=======================================
Files 21 21
Lines 1765 1765
Branches 295 295
=======================================
Hits 1655 1655
Misses 73 73
Partials 37 37 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
roedoejet
requested changes
May 27, 2026
Collaborator
roedoejet
left a comment
roedoejet
left a comment
There was a problem hiding this comment.
small jargon changes requested. Otherwise lgtm and this is a good addition to the file.
| BASIC_HTML = """ | ||
| <!DOCTYPE html> | ||
|
|
||
| <!-- DO NOT USE THIS VERSION ON A WEBSITE. See Webmaster Instructions below --> |
Collaborator
There was a problem hiding this comment.
Suggested change
| <!-- DO NOT USE THIS VERSION ON A WEBSITE. See Webmaster Instructions below --> | |
| <!-- DO NOT USE THIS VERSION ON A WEBSITE. See Web Developer Instructions below --> |
Collaborator
There was a problem hiding this comment.
Website Administrator, Web Admin, or Web Developer are all more standard terms now.
|
|
||
| <!-- | ||
|
|
||
| Webmaster Instructions |
Collaborator
There was a problem hiding this comment.
Suggested change
| Webmaster Instructions | |
| Web Developer Instructions |
| Webmaster Instructions | ||
|
|
||
| Before publishing this ReadAlong on a web site, please convert it to a Web | ||
| Bundle. This monolithic format is the master file for editing and for offline |
Collaborator
There was a problem hiding this comment.
Suggested change
| Bundle. This monolithic format is the master file for editing and for offline | |
| Bundle. This monolithic format is the main file for editing and for offline |
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
2 participants
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.
PR Goal?
Give webmasters a blunt message that the single-file HTML format is not intended for publication as is.
Feedback sought?
review the text
Priority?
normal
Tests added?
not needed
How to test?
and see the webmaster webmaster warning and then the webmaster instructions.
Confidence?
high
Version change?
no
Related PR
ReadAlongs/Studio-Web#554