Skip to content

feat: add serving instructions to the end of the build script output #432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pemamian wants to merge 2 commits into
base: main
Choose a base branch
from
+5 −0
Open

feat: add serving instructions to the end of the build script output #432

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a7e769
feat: add serving instructions to the end of the build script output
pemamian May 11, 2026
cdbfd3f
Merge branch 'main' into improve-build-local-help
pemamian May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions scripts/build_local.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,8 @@ echo "Extracting: $EXTRACT_LIST"
git archive "$GH_PAGES_BRANCH" $EXTRACT_LIST | tar -x -C "$OUTPUT_DIR"

echo "=== Build Complete! ==="
echo "To serve the fully built site (with versioning):"
echo " python3 -m http.server 8000 -d $OUTPUT_DIR"
echo ""
echo "Alternative (faster for live editing current version):"
echo " uv run mkdocs serve"
Copy link
Copy Markdown
Contributor

@damaz91 damaz91 May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'm not convinced "uv run mkdocs serve" produces the exact same result of "python3 -m http.server 8000 -d $OUTPUT_DIR"; also, we added the instruction of 136 in #452 so i'm not sure it's super useful to have it printed in the output of the script as well

Copy link
Copy Markdown
Contributor Author

@pemamian pemamian May 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

although #452 is explaining the issue, we want to encourage developer builds and helping them see the issues sooner. These instructions used to be in the file before some update removed them. (personally useful)
-- no comment on the different of python3 vs uv run mkdocs serve

Loading