-
Notifications
You must be signed in to change notification settings - Fork 393
chore: Include schema and documentation development instructions in README.md for better discoverability #452
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.
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
base: main
Are you sure you want to change the base?
Changes from 6 commits
83f12ee
afc8f6f
3a7037c
81bfdf6
931e8c4
91637ff
7903dda
8c12d8a
0e5e42e
547ab19
d919178
1742a02
bd2c135
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -118,6 +118,58 @@ We welcome community contributions to enhance and evolve UCP. | |
| * **Contribution Guide:** See our [CONTRIBUTING.md](https://github.com/Universal-Commerce-Protocol/.github/blob/main/CONTRIBUTING.md) | ||
| for details on how to contribute. | ||
|
|
||
| ### 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) | ||
| to resolve annotations for specific operations at runtime. | ||
|
|
||
| 1. Ensure `ucp-schema` is installed: | ||
|
|
||
| ```bash | ||
| cargo install ucp-schema # from crates.io | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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) |
||
| cargo install --git https://github.com/universal-commerce-protocol/ucp-schema # from git | ||
| ``` | ||
|
|
||
| 2. Make updates to JSON files in `source/` | ||
| 3. Run | ||
|
|
||
| ```bash | ||
| ucp-schema lint source/ | ||
| ``` | ||
|
|
||
| to validate syntax and references | ||
|
damaz91 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ### Documentation Development | ||
|
|
||
| This project uses [uv](https://docs.astral.sh/uv/) for Python dependency management. | ||
|
|
||
| 1. Install Python dependencies: `uv sync` | ||
| 2. Ensure `ucp-schema` is installed (see above) | ||
| 3. Run the development server: `uv run mkdocs serve --watch source` | ||
| 4. Open **<http://127.0.0.1:8000>** in your browser | ||
| 5. Before submitting, run `uv run mkdocs build --strict` to check for warnings/errors | ||
|
|
||
| Alternatively, you can use the local build script to build the full site including spec versions: | ||
|
|
||
| ```bash | ||
| ./scripts/build_local.sh | ||
| ``` | ||
|
|
||
| This will build the site and start a local server. You can use the `--draft-only` flag to skip release branches and only build the current draft: | ||
|
damaz91 marked this conversation as resolved.
Outdated
|
||
|
|
||
| ```bash | ||
| ./scripts/build_local.sh --draft-only | ||
| ``` | ||
|
|
||
| You can start the documentation server locally by running | ||
|
|
||
| ```bash | ||
| python3 -m http.server 8000 -d "local_preview" | ||
| ``` | ||
|
|
||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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? |
||
| ## What's Next | ||
|
|
||
| Take a look at [our roadmap on ucp.dev](https://ucp.dev/documentation/roadmap/). | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Define "Agents" better? What are they, how do they "use" ucp-schema?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please take a look now