Skip to content

Commit 7d7af56

Browse files
os-zhuangclaude
andauthored
docs: README says SSO is free; ROADMAP.md becomes a short North Star summary (#31532)
<!-- claude-projects-attribution: {"github_login":"os-zhuang"} --> _Requested by **Sam** · [project thread](https://claude.ai/code/project/chan_01GsBogozeZG5sdpAARrN7HP?thread=cmsg_01GsBogozeZG5sdpAARrN7HPCiLqQ2HSnXR9Jz2eBoFXGK)_ Refs objectstack-ai/cloud#3844, objectstack-ai/cloud#3834 (README row), objectstack-ai/cloud#3835 (item 2) ## What changes - **`README.md` (You own it, lines 195–196):** single sign-on (OIDC / SAML) is part of what this repository ships, free. "multi-environment operations" is dropped from what ObjectOS Cloud and Enterprise add: Cloud now has one environment per organization, and the dev environment type was retired. - **`ROADMAP.md`:** the 2026-06-06 file (stale documentation chores and an outdated architecture list) becomes a short public summary: - names the *Features on the road* table in `docs/NORTH-STAR.md` as the source of truth, and says the North Star wins where they differ; - distils **Now / Next / Later** from the road's steps, in the table's order: Now = set out, run it locally, verify; Next = publish and install, connect an agent; Later = iterate on a customer request. It says the weekly walk, not this page, decides which step is P0; - one line pointing to objectos.ai for the commercial editions' roadmap; - keeps the "where the details live" pointers (issues, milestones, CHANGELOGs, platform checklist, ADRs, `ui/`). - It has no Enterprise content. ## Why cloud#3834: the README still told readers SSO was a Cloud / Enterprise add-on, and named multi-environment operations that no longer exist. cloud#3835 item 2: the open-source ROADMAP.md should be a North Star summary, and Enterprise roadmap content does not belong in this repository. ## Verification - `node scripts/check-doc-anchors.mjs`: 952 internal fragment links resolve. - `node scripts/check-doc-authoring.mjs`: clean. - `node scripts/check-issue-citations.mjs`: no citations added. - Every relative link in the new ROADMAP.md points at an existing path (`docs/NORTH-STAR.md`, `docs/qa/platform-checklist/`, `docs/adr`, `ui/docs/adr`, `ui/CHANGELOG.md`). The README's T1–T4 lines (7–31), which www.objectos.ai quotes, are untouched. - Neither file is a governed surface. The diff publishes nothing, so it needs the `skip-changeset` label rather than a changeset. Clause-②: no Metadata-protocol: none ## Human Minimum - [x] 1. Schemas start as Zod; `packages/spec` holds no runtime logic. (not touched) - [x] 2. Every name I added uses the casing for its kind. (no names) - [x] 3. No formatter ran; `pnpm lint` passes. (Markdown only) - [x] 4. One issue, one branch off an up-to-date `main`, one pull request. - [x] 5. A change that publishes carries a changeset, and both declaration lines are filled in here and in the changeset. (publishes nothing) - [x] 6. `packages/spec` touched: its generated artifacts are regenerated and committed. (not touched) - [x] 7. No hand edits to `content/docs/references/`, `packages/*/CHANGELOG.md` or `content/docs/releases/`. - [x] 8. Title, body and comments are in English. - [x] The *Before Submitting* list in CONTRIBUTING.md is done. --- _Generated by [Claude Code](https://claude.ai/code/session_01QUs3BunwL2z47faKvzA68i)_ Co-authored-by: Claude <noreply@anthropic.com>
1 parent 210ef60 commit 7d7af56

2 files changed

Lines changed: 50 additions & 76 deletions

File tree

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,8 +192,8 @@ tests excluded, at commit `95294be3`).
192192

193193
**Everything needed to run an app is in this repository** — protocol,
194194
microkernel, SDK, CLI, the production runtime and Console, permissions, audit,
195-
and MCP. ObjectOS Cloud and Enterprise add hosting and multi-environment
196-
operations, Build & Ask, SSO, and support.
195+
and MCP — single sign-on (OIDC / SAML) included, free. ObjectOS Cloud and
196+
Enterprise add hosting, Build & Ask, and support.
197197
This repository is Apache-2.0, except `ui/` (the Console and `@object-ui/*`), which is MIT — both permissive
198198
([LICENSING.md](./LICENSING.md)). The definition lives in your repository as
199199
ordinary TypeScript, versioned in your VCS and reviewable as a diff — not a

‎ROADMAP.md‎

Lines changed: 48 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -1,91 +1,65 @@
11
# ObjectStack Roadmap
22

3-
> **Last updated:** 2026-06-06
4-
> **Source of truth:** [docs/NORTH-STAR.md](docs/NORTH-STAR.md), the one North Star, for product direction and priority, ADRs for architectural decisions, and code for shipped behavior.
3+
> **Last updated:** 2026-11-08
4+
> **Source of truth:** the *Features on the road* table in
5+
> [docs/NORTH-STAR.md](docs/NORTH-STAR.md). That table is the roadmap: its order is the
6+
> priority, and editing it is editing priority. This page is a short public summary of it
7+
> and decides nothing on its own. Where the two disagree, the North Star wins.
58
6-
This roadmap tracks the current framework repository. Historical Cloud/ObjectOS
7-
milestone plans that referred to `apps/cloud`, `apps/objectos`,
8-
`@objectstack/service-tenant`, `sys_project`, or `/api/v1/cloud/projects/*`
9-
have been retired. Cloud control-plane distribution work now lives outside this
10-
repo; this repo owns the framework runtime, protocol schemas, CLI, examples,
11-
docs, adapters, services, plugins, and the bundled console integration.
9+
ObjectStack is measured by one road: a new AI developer, with a human accepting, starts
10+
from `npm create objectstack`, writes metadata, runs it locally, has verification reject
11+
what is wrong, publishes and installs it into an environment, connects an agent over MCP
12+
to complete one real business operation, and iterates once on a customer request. The
13+
road is walked every week; the first step that breaks is the current P0. Security and
14+
data integrity come first and do not wait for the road.
1215

13-
---
16+
## Now
1417

15-
## Current Architecture
18+
The first three steps of the road, where an application is written, run and checked:
1619

17-
- **Runtime:** `@objectstack/runtime` boots standalone/local hosts and exposes
18-
Cloud-aware seams such as environment registry, runtime config, marketplace
19-
proxy, and environment artifact loading.
20-
- **Environment identity:** current docs and runtime paths use
21-
`environment`, not `project`: `OS_ENVIRONMENT_ID`,
22-
`X-Environment-Id`, `/api/v1/environments/:environmentId`, and
23-
`environment_id`.
24-
- **Console UI:** framework serves the ObjectUI console bundle from
25-
`packages/console`; its source is the `ui/` workspace of this repository
26-
(`ui/apps/console` and the `@object-ui/*` packages), and `pnpm console:build`
27-
builds it into `packages/console`.
28-
- **Cloud publishing:** CLI publish/rollback target
29-
`/api/v1/cloud/environments/:environment/...` endpoints when pointed at an
30-
ObjectOS Cloud control plane.
31-
- **Generated references:** `content/docs/references/` is generated from Zod
32-
descriptions. Update `packages/spec/src/**/*.zod.ts`, then regenerate.
20+
- **Set out.** One command scaffolds a project that installs, verifies and paints its
21+
first screen; the build is the author's first gate; objects, views, forms, record pages
22+
and custom pages are built without writing code, draft first and then published.
23+
- **Run it locally and see it.** Every capability a business user needs, working in the
24+
running application: records and forms, list views, kanban, calendar and Gantt,
25+
permissions that hold on both sides, sharing, sign-in and identity, approvals and
26+
flows, reports and dashboards, files, the customer's language, and an API others can
27+
call.
28+
- **Verify.** `objectstack verify`, lint and the health check loudly refuse what is wrong,
29+
with a prescription, and let through what is right.
3330

34-
---
31+
## Next
3532

36-
## Near-Term Priorities
33+
- **Publish and install into an environment.** Packages with an enforced manifest,
34+
install with or without a control plane, migrations that show their plan first, and an
35+
ontology you own: diffable in your repository and exportable to run without us.
36+
- **Connect an agent.** The MCP surface exposes what the application really can do,
37+
fails closed, and says plainly what the open edition does not include.
3738

38-
| Priority | Work | Why |
39-
|:---|:---|:---|
40-
| P0 | Keep public docs aligned with the environment rename. | Prevent users from copying stale `project` route/header/env examples. |
41-
| P0 | Keep CLI/docs/examples aligned with actual scripts: `pnpm dev`, `pnpm dev:crm`, `os dev`, `os start`, `os serve`, `os publish`. | Avoid broken onboarding. |
42-
| P0 | Remove references to deleted app/service packages from current docs. | `apps/cloud`, `apps/objectos`, `apps/studio`, and `service-tenant` no longer exist in this repo. |
43-
| ~~P1~~ done | ~~Document Flow-first automation and workflow state-machine semantics.~~ Flow automation is documented in [guides/metadata/flow](content/docs/automation/flows.mdx) (triggers, nodes, structured control flow, durable pause/resume, parallel + batch approval, run observability) and the ADR-0019/0031/0039 series; state-machine semantics in [guides/metadata/workflow](content/docs/automation/workflows.mdx) + [validation](content/docs/data-modeling/validation.mdx). | Old Workflow Rule docs implied a retired Salesforce-style rule engine. |
44-
| P1 | Document explicit AI action opt-in via action metadata. | AI tool exposure is no longer automatic for every action. |
45-
| P1 | Document implemented formula, summary, autonumber, notifications, and master-detail behavior. | Recent runtime work is under-documented and older status pages still mark it missing. |
46-
| P2 | Regenerate reference docs after Zod description updates. | Keeps generated schema pages consistent without hand-editing them. |
39+
## Later
4740

48-
---
41+
- **Iterate on a customer request.** The first-run loop end to end with zero code and zero
42+
restarts, bringing the customer's existing data in, and structural changes that a dev
43+
boot heals safely while production takes no liberties.
4944

50-
## Documentation Rules
45+
The order above follows the table. Which step is P0 at any moment is decided by the
46+
weekly walk, not by this page.
5147

52-
- Do not hand-edit `content/docs/references/`.
53-
- When adding guide pages, update the nearest `meta.json`.
54-
- Use `environment` for runtime/deployment identity.
55-
- Use `project` only for npm/monorepo/project-folder meaning, or when quoting
56-
historical ADR text.
57-
- Link to UI work by its path under `ui/`, never the archived ObjectUI
58-
repository, `../objectui` or `apps/studio`.
48+
## Commercial editions
5949

60-
---
50+
ObjectOS Cloud and ObjectOS Enterprise are the commercial editions built on this
51+
framework. Their roadmap is published at [objectos.ai](https://objectos.ai), not here.
6152

62-
## ObjectUI (`ui/`)
53+
## Where the details live
6354

64-
The view layer is planned and tracked like the rest of this repository; plans and
65-
their status live where they are tracked, not in this file:
66-
67-
- **Open work:** [issues](https://github.com/objectstack-ai/objectstack/issues),
68-
filtered by the `area:*` labels for one feature axis and by `priority:*` for order.
55+
- **Open work:** [issues](https://github.com/objectstack-ai/objectstack/issues), filtered
56+
by the `area:*` labels for one feature axis and by `priority:*` for order.
6957
- **Release targets:** [milestones](https://github.com/objectstack-ai/objectstack/milestones)
7058
and the `target:*` labels.
71-
- **What has shipped:** each `@object-ui/*` package's own `CHANGELOG.md`;
72-
[ui/CHANGELOG.md](ui/CHANGELOG.md) is the frozen history of ObjectUI's own releases.
73-
- **Design decisions:** the ADRs in [ui/docs/adr](ui/docs/adr) for the view layer.
74-
75-
ObjectUI's long-form roadmap stopped at v3.3.2 (May 2026); it is in the git history of
76-
`ui/ROADMAP.md`.
77-
78-
---
79-
80-
## Verification
81-
82-
For doc-only updates, prefer targeted checks:
83-
84-
```bash
85-
pnpm --filter @objectstack/docs build
86-
pnpm --filter @objectstack/spec gen:docs
87-
rg "X-Project-Id|OS_PROJECT_ID|/api/v1/projects|sys_project|apps/studio|service-tenant" README.md content/docs docs/design docs/handoff packages/spec/src
88-
```
89-
90-
Run the full `pnpm test` suite when documentation changes accompany runtime or
91-
schema behavior changes.
59+
- **What has shipped:** each package's own `CHANGELOG.md`; for the view layer under `ui/`,
60+
each `@object-ui/*` package's `CHANGELOG.md`, with [ui/CHANGELOG.md](ui/CHANGELOG.md) as
61+
the frozen history of ObjectUI's own releases.
62+
- **What each feature must do, and how it is verified:**
63+
[docs/qa/platform-checklist/](docs/qa/platform-checklist/).
64+
- **Design decisions:** the ADRs in [docs/adr](docs/adr), and in [ui/docs/adr](ui/docs/adr)
65+
for the view layer.

0 commit comments

Comments
 (0)