Skip to content

docs(readme): reposition as the developer framework (vs the ObjectOS runtime) - #2297

Merged
os-zhuang merged 1 commit into
mainfrom
docs/readme-reposition
Jun 24, 2026
Merged

os-zhuang merged 1 commit into
mainfrom
docs/readme-reposition

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

What

framework (ObjectStack) is the developer framework; ../objectos is the end-user runtime. The README had drifted into ObjectOS's territory (runtime dashboards, "AI operates it within RBAC/RLS/audit"). This repositions it around the framework/protocol story.

  • Hero — dev/protocol tagline + an ObjectStack → describe / ObjectOS → run boundary box; leads with the metadata→surfaces architecture diagram instead of a runtime dashboard.
  • Author your app — replaces "See it in action": a real ObjectSchema sample + Studio object/flow designers (authoring is the framework's surface). The runtime gallery moved to the ObjectOS README (docs(readme): add "See it running" screenshots of apps + AI on ObjectOS objectos#31) with a "see it running" link.
  • Use the generated API — REST example + SDK/plugin pointers for developers.
  • Dedupe — runtime/governance claims now point to ObjectOS.
  • Removes the 6 runtime screenshots (now hosted in objectos).

Pairs with objectstack-ai/objectos#31. Docs-only.

🤖 Generated with Claude Code

…runtime)

ObjectStack describes apps; ObjectOS runs them. Refocus the README on the
framework/protocol story and hand the runtime narrative to ObjectOS.

- Dev/protocol hero tagline + an ObjectStack-vs-ObjectOS boundary box
- Lead with the architecture (metadata -> surfaces) diagram instead of a
  runtime dashboard screenshot
- Replace "See it in action" with "Author your app" — a Zod ObjectSchema
  sample + Studio object/flow designers; move the runtime gallery
  (dashboard, kanban, Gantt, calendar, gallery, AI) to the ObjectOS README
- Add a "Use the generated API" section (REST + SDK/plugin pointers)
- Point runtime/governance claims (RBAC/RLS/audit) to ObjectOS
- Remove the 6 runtime screenshots now hosted in objectos

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 24, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jun 24, 2026 4:26pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/s labels Jun 24, 2026
@os-zhuang
os-zhuang merged commit 8eb56b0 into main Jun 24, 2026
14 of 15 checks passed
@os-zhuang
os-zhuang deleted the docs/readme-reposition branch June 24, 2026 15:56

This branch was successfully deployed

1 active deployment
Preview — eb9cad6f Deployed Jun 24, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant