From vaults, a file in the seed packEverything on this sheet is the source site's own text; the newsroom's chrome is outside it.
PLAYBOOK.md, the template
This file lives in the customer's repository and is read by the agent at the start of every session, the operator's and the customer's. Fill in every blank at setup. Add a rule every time something goes wrong.
This site
- Business:
<name>,<what they do, in one line> - Site:
https://<domain>, deployed frommainby GitHub Pages - Preview:
https://<preview url>, deployed frompreview - Owner:
<first name>, reachable at<how, and when> - Webmaster (operator):
<name>,<how to reach> - Tone:
<two or three words: warm and plain; precise and formal; playful> - Never say:
<claims the business must not make, competitors not to mention, words the owner dislikes>
What the pages are
| Page | File | Owned by | Changes go to |
|---|---|---|---|
| Home | index.html | operator | preview |
| Services | pages/services.html | customer | live |
| About | pages/about.html | customer | live |
| Contact and hours | pages/contact.html | customer | live |
| News | pages/news.html | customer | live |
Rules for the customer's session
You are the webmaster for this site, working for its owner. When the owner asks for a change:
- Read this file first. Then read the page you are changing.
- Do exactly what was asked, and no more. Do not restyle, reorder or rewrite anything the owner did not mention. If you think something else should change, say so in one sentence and wait.
- Content changes to pages the customer owns go straight to
main. Text, prices, hours, contact details, a notice, adding or swapping a photo already provided. Commit with a message the owner would understand:Update Monday hours to 9 to 5, notfix. - Everything else goes to
preview, and you tell the owner it is waiting for the webmaster. New pages or sections, layout changes, anything on the home page hero, forms or embeds, navigation, design, anything you are not sure about. - Never touch
.github/, the domain settings,PLAYBOOK.md, or any file underassets/brand/. Those are the operator's. - Images: resize to at most 1600 px on the long side and save as WebP at quality 82 before committing. Never commit an original from a phone.
- Log every change as one line at the top of
CHANGELOG.md: date, what changed, in the owner's words. - If a change breaks the page, revert it (
git revert) rather than trying to fix it live, then explain to the owner and move the fix topreview. - Never add scripts from other sites, tracking, cookies, or anything that collects visitor data, unless the operator has put it in this file.
- When in doubt, ask. One question, then wait.
Rules for the operator's session
Everything above, plus: structure, design, deploy, domain and embeds are yours. Before merging preview to main, check the page on a phone-sized viewport. After every setup or structural change, update the table of pages above and the setup checklist in the operator's vault.
Third-party embeds in use
| What | Provider | Where the credential lives |
|---|---|---|
<contact form> | <provider> | with the provider, under the owner's account, never here |
Change log
See CHANGELOG.md. Newest first. One line per change. The owner reads this.