docs: clarify local site build and serve steps - #796
Open
FanouZeng-TT wants to merge 1 commit into
Open
Conversation
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
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.
Description
The documentation says
./scripts/build_local.sh"will build the site andstart a local server," but the script only builds
local_preview/and printsthe command that the user must run next:
There is no executable
python3 -m http.serverormkdocs serveinvocation inthe script. The README already provides the manual server command immediately
below, so the current sentence incorrectly promises a running server when the
build finishes.
Fix: describe build and serve as two steps: the script builds the site, and
the command below starts the local server.
Category (Required)
Related Issues
N/A
Checklist
generate_models.shunderpython_sdk.Screenshots / Logs (if applicable)
Static script check confirms no executable server command; full example validators
and validator unit tests pass with
ucp-schemaon PATH. All remainingpre-commit hooks (cspell, whitespace, YAML, shebang, Ruff, markdownlint,
stylelint, Prettier) and
git diff --checkpass.