chore: Include schema and documentation development instructions in README.md for better discoverability#452
Open
damaz91 wants to merge 13 commits into
Open
chore: Include schema and documentation development instructions in README.md for better discoverability#452damaz91 wants to merge 13 commits into
damaz91 wants to merge 13 commits into
Conversation
…EADME.md for better discoverability
ptiper
reviewed
May 19, 2026
| ### Schema Development | ||
|
|
||
| Schemas live in `source/` and are published with `ucp_*` annotations intact. | ||
| Agents use [ucp-schema](https://github.com/universal-commerce-protocol/ucp-schema) |
Contributor
There was a problem hiding this comment.
Define "Agents" better? What are they, how do they "use" ucp-schema?
Contributor
Author
There was a problem hiding this comment.
please take a look now
…mmerce-Protocol/ucp into chore/readme-update
ptiper
approved these changes
May 20, 2026
|
|
||
| The local version of the documentation website will then be available at | ||
| **<http://127.0.0.1:8000>** | ||
|
|
Contributor
There was a problem hiding this comment.
Final nit: maybe add that for contributing to SDKs, Samples, Conformance or other repos, the README in those repos will contain relevant information on specific developer workflows / instructions?
ptiper
requested review from
pemamian
and removed request for
archrao and
kmcduffie
15 tasks
pemamian
approved these changes
May 21, 2026
wry-ry
approved these changes
May 21, 2026
pemamian
reviewed
May 21, 2026
| 1. Ensure `ucp-schema` is installed: | ||
|
|
||
| ```bash | ||
| cargo install ucp-schema # from crates.io |
Contributor
There was a problem hiding this comment.
one of these lines is enough for having the cargo, right ? so i suggest splitting the bash code section in 2 and putting an OR in between. (lazy developer would just copy the lines and run in command line and would have issues running both)
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
4 participants
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
Include schema and documentation development instructions in README.md for better discoverability
Category (Required)
Please select one or more categories that apply to this change.
ucp-schematool (resolver, linter, validator). (Requires Maintainer approval)Checklist
!for breaking changes).