Skip to content

docs: clarify README as sample app, not an official Warp product - #36

Draft
warp-agent-staging[bot] wants to merge 2 commits into
mainfrom
factory/readme-sample-app-clarify
Draft

docs: clarify README as sample app, not an official Warp product#36
warp-agent-staging[bot] wants to merge 2 commits into
mainfrom
factory/readme-sample-app-clarify

Conversation

@warp-agent-staging

Copy link
Copy Markdown

Summary

A customer (Riot) came away from a call believing oz-workspace was an officially supported Warp product. It isn't — it's a sample app that showcases what you can build on Warp's cloud agent SDK (the Oz Agent API). The README's opening line ("Oz Workspace is an open-source collaborative AI agent workspace built with Warp's Oz API...") reads like a product pitch and never states that it's a sample or that it's unsupported, which is the likely source of the confusion.

Changes

  • Added a short callout at the top of the README stating plainly that this is a sample app, not an official Warp product, with no SLA or support commitment, and pointing readers at the Warp docs for the supported SDK/API surface.
  • Reworded the original opening sentence to frame the project as a sample showcasing the Oz API rather than as a standalone product.
  • Left setup, project structure, scripts, and everything else in the README unchanged.

Verification

Docs-only change (no code, CONTRIBUTING.md, or LICENSE touched). Reviewed the rendered Markdown by eye; no build/test steps apply.

@warp-agent-staging

Copy link
Copy Markdown
Author

This PR was generated with Warp.

Comment @warp-factory on this PR to send it follow-up work.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants