Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/samgutentag/sbburgerweek/llms.txt

Use this file to discover all available pages before exploring further.

GitHub Pages serves the map directly from the repo root — no build pipeline, no CI step, no artifact upload. The project is plain HTML, CSS, and JavaScript with no bundler, so every file you push is exactly what visitors receive.

​
Deploying from the repo root

1

Open your repo settings

Navigate to your forked repository on GitHub and click the Settings tab at the top of the page.
2

Go to the Pages section

In the left sidebar, click Pages (under the “Code and automation” heading).
3

Choose your source

Under Source, select Deploy from a branch from the dropdown menu.
4

Select the branch and folder

Set the branch to main and the folder to / (root), then click Save.
5

Wait for the first deployment

GitHub Pages takes 1–2 minutes to build and publish the site after the initial save. A banner will appear at the top of the Pages settings page once it’s ready.
6

Visit your live site

Your map is now live at:
https://YOUR_USERNAME.github.io/sbburgerweek/
Replace YOUR_USERNAME with your actual GitHub username.

​
Testing locally first

Before pushing to GitHub Pages, run the map locally to verify everything looks correct. A local HTTP server is required — opening index.html directly via file:// won’t work because scripts load via relative paths. 
python3 -m http.server 8000 --bind 127.0.0.1
Then open http://localhost:8000 in your browser. Add ?year=9999 to the URL to test with skeleton data (no menu details).

​
After pushing changes

GitHub Pages automatically redeploys on every push to the main branch. No further action is needed after the initial setup — commit your changes, push, and the live site updates within a minute or two. 
git add .
git commit -m "Update restaurant data and config"
git push
A custom domain is optional but gives a cleaner URL than username.github.io/sbburgerweek. See Custom Domain for step-by-step DNS and GitHub Pages configuration.
If you forked from the original repo, check whether a file named tracking-snapshot.js exists in the repo root. If it does, delete it before deploying — it contains baked-in stats data from the previous event and will cause the stats page to show stale data. The file is regenerated automatically by the snapshot workflow during your own event.

Build docs developers (and LLMs) love

Get started for freeTalk to us