Skip to content

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

Open
pemamian wants to merge 2 commits into
mainfrom
improve-build-local-help
Open

feat: add serving instructions to the end of the build script output#432
pemamian wants to merge 2 commits into
mainfrom
improve-build-local-help

Conversation

@pemamian
Copy link
Copy Markdown
Contributor

Description

instruction for hosting docs locally after successful local build.

Category (Required)

Please select one or more categories that apply to this change.

  • Core Protocol: Changes to the base communication layer, global context, or breaking refactors. (Requires Technical Council approval)
  • Governance/Contributing: Updates to GOVERNANCE.md, CONTRIBUTING.md, or CODEOWNERS. (Requires Governance Council approval)
  • Capability: New schemas (Discovery, Cart, etc.) or extensions. (Requires Maintainer approval)
  • Documentation: Updates to README, or documentations regarding schema or capabilities. (Requires Maintainer approval)
  • Infrastructure: CI/CD, Linters, or build scripts. (Requires DevOps Maintainer approval)
  • Maintenance: Version bumps, lockfile updates, or minor bug fixes. (Requires DevOps Maintainer approval)
  • SDK: Language-specific SDK updates and releases. (Requires DevOps Maintainer approval)
  • Samples / Conformance: Maintaining samples and the conformance suite. (Requires Maintainer approval)
  • UCP Schema: Changes to the ucp-schema tool (resolver, linter, validator). (Requires Maintainer approval)
  • Community Health (.github): Updates to templates, workflows, or org-level configs. (Requires DevOps Maintainer approval)

Related Issues

Checklist

  • I have followed the Contributing Guide.
  • I have updated the documentation (if applicable).
  • My changes pass all local linting and formatting checks.
  • (For Core/Capability) I have included/updated the relevant JSON schemas.
  • I have regenerated Python Pydantic models by running generate_models.sh under python_sdk.

Screenshots / Logs (if applicable)

@pemamian pemamian marked this pull request as ready for review May 12, 2026 08:20
@pemamian pemamian requested review from a team as code owners May 12, 2026 08:20
@pemamian
Copy link
Copy Markdown
Contributor Author

these was removed by prior commits, returning them back.

@pemamian pemamian requested a review from ptiper May 21, 2026 13:54
Comment thread scripts/build_local.sh
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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants