Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions .changeset/canonical-docs-host-in-published-links.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
---
"create-objectstack": patch
"@objectstack/knowledge-ragflow": patch
"@objectstack/plugin-audit": patch
"@objectstack/service-analytics": patch
"@objectstack/service-automation": patch
"@objectstack/service-cache": patch
"@objectstack/service-i18n": patch
"@objectstack/service-job": patch
"@objectstack/service-knowledge": patch
---

Point every documentation link in these packages' published READMEs — and in
the project `create-objectstack` scaffolds — at the canonical docs origin
`https://objectstack.ai`, replacing the `docs.objectstack.ai` spelling.

Both spellings reach the same pages (the alias redirects to the apex,
path-preserving), so no link was broken. The reason it needs a release rather
than an in-repo fix alone: a README ships inside the npm tarball, so the
version already on npm keeps showing the old host to every reader of the
package page until a new one is published.
2 changes: 1 addition & 1 deletion content/docs.site.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@
"meta": {
"title": "Object Protocol",
"description": "The Metadata-Driven Documentation Engine for the Low-Code Era.",
"url": "https://protocol.objectstack.ai",
"url": "https://objectstack.ai",
"favicon": "https://objectstack.ai/logo.svg"
},
"i18n": {
Expand Down
4 changes: 2 additions & 2 deletions docker/Dockerfile
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,11 +29,11 @@
#
# The `#sha256=` fragment is an optional SRI-style integrity pin, verified
# before boot; a mismatch refuses to boot. Docs:
# https://docs.objectstack.ai/docs/deployment/self-hosting#artifact-pinned-boot-os_artifact_url
# https://objectstack.ai/docs/deployment/self-hosting#artifact-pinned-boot-os_artifact_url
#
# Published by .github/workflows/docker-publish.yml on every framework
# release; the image tag always matches the @objectstack/cli version inside.
# Docs: https://docs.objectstack.ai/docs/deployment/self-hosting
# Docs: https://objectstack.ai/docs/deployment/self-hosting

FROM node:22-slim

Expand Down
2 changes: 1 addition & 1 deletion packages/create-objectstack/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -87,7 +87,7 @@ npm run validate # verify metadata: schema + predicates + bindings
```

See the docs:
[Your First Project](https://docs.objectstack.ai/docs/getting-started/your-first-project).
[Your First Project](https://objectstack.ai/docs/getting-started/your-first-project).

## License

Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/knowledge-ragflow/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,7 @@

[RAGFlow](https://github.com/infiniflow/ragflow) `IKnowledgeAdapter` for ObjectStack.

Bridges the [Knowledge Protocol](https://docs.objectstack.ai/docs/protocol/knowledge) to a RAGFlow deployment via its HTTP API. RAGFlow handles chunking (DeepDoc), embedding, hybrid retrieval, and reranking; ObjectStack handles metadata-native sources and permission-aware filtering on top of the returned hits.
Bridges the [Knowledge Protocol](https://objectstack.ai/docs/protocol/knowledge) to a RAGFlow deployment via its HTTP API. RAGFlow handles chunking (DeepDoc), embedding, hybrid retrieval, and reranking; ObjectStack handles metadata-native sources and permission-aware filtering on top of the returned hits.

## Why RAGFlow?

Expand Down
4 changes: 2 additions & 2 deletions packages/plugins/plugin-audit/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -365,7 +365,7 @@ Permission sets that use the **hierarchy-relative depth scopes** (`own_and_repor
`@objectstack/security-enterprise`. The open edition ships no resolver, so those scopes
**fail closed to `own`** — they never widen visibility without it. A grant written to let
managers read their reports' audit rows will, on an open build, show them only their own.
See [Access depth](https://docs.objectstack.ai/docs/permissions/permission-sets#access-depth--readscope--writescope-adr-0057-d1).
See [Access depth](https://objectstack.ai/docs/permissions/permission-sets#access-depth--readscope--writescope-adr-0057-d1).

`sys_comment`'s record-level edit gates resolve the `sharing` service lazily; without it
those checks degrade to parent-record read visibility. If the engine exposes no middleware
Expand DownExpand Up@@ -419,6 +419,6 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md).

- [@objectstack/plugin-security](../plugin-security/) — permissions, RLS and field-level security
- [@objectstack/plugin-auth](../plugin-auth/) — the caller of the `audit` slot's auth-event ingress
- [`services.audit` reference](https://docs.objectstack.ai/docs/kernel/runtime-services/audit-service) — the slot's
- [`services.audit` reference](https://objectstack.ai/docs/kernel/runtime-services/audit-service) — the slot's
full event shape, its never-throws failure posture, and why `SettingsAuditSink.record()`
is not this slot
2 changes: 1 addition & 1 deletion packages/services/service-analytics/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -193,4 +193,4 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md).

- [@objectstack/objectql](../../objectql/)
- [@objectstack/driver-memory](../../drivers/driver-memory/) — ships `InMemoryStrategy`
- [Analytics Guide](https://docs.objectstack.ai/docs/data-modeling/analytics)
- [Analytics Guide](https://objectstack.ai/docs/data-modeling/analytics)
6 changes: 3 additions & 3 deletions packages/services/service-automation/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -175,7 +175,7 @@ array of `{ field, operator, value }` triples; operator objects such as
through `filter`. Unknown keys are rejected at `registerFlow()`.

For every other node's `config`, and for loops, parallel blocks, subflows, waits
and error handling, see the maintained reference — **[Flows](https://docs.objectstack.ai/docs/automation/flows)**.
and error handling, see the maintained reference — **[Flows](https://objectstack.ai/docs/automation/flows)**.
This README deliberately does not keep a second copy of that per-node reference.

## Expressions
Expand DownExpand Up@@ -456,7 +456,7 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md).
## See Also

- [@objectstack/spec/automation](../../spec/src/automation/)
- [Automation](https://docs.objectstack.ai/docs/automation) — the automation docs section: hooks, flows,
- [Automation](https://objectstack.ai/docs/automation) — the automation docs section: hooks, flows,
workflows, approvals, webhooks, connectors
- [Automation Protocol](https://docs.objectstack.ai/docs/references/automation) — the complete schema
- [Automation Protocol](https://objectstack.ai/docs/references/automation) — the complete schema
reference for the automation protocol
2 changes: 1 addition & 1 deletion packages/services/service-cache/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -148,4 +148,4 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md).
## See Also

- [@objectstack/spec/contracts](../../spec/src/contracts/)
- [Cache Service](https://docs.objectstack.ai/docs/kernel/contracts/cache-service)
- [Cache Service](https://objectstack.ai/docs/kernel/contracts/cache-service)
2 changes: 1 addition & 1 deletion packages/services/service-i18n/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -193,4 +193,4 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md).
## See Also

- [@objectstack/spec/system](../../spec/src/system/) — the `translation` metadata schema
- [I18n Standard](https://docs.objectstack.ai/docs/protocol/kernel/i18n-standard)
- [I18n Standard](https://objectstack.ai/docs/protocol/kernel/i18n-standard)
2 changes: 1 addition & 1 deletion packages/services/service-job/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -183,4 +183,4 @@ Apache-2.0. See [LICENSING.md](../../../LICENSING.md).

- [@objectstack/spec/contracts](../../spec/src/contracts/)
- [Cron Expression Generator](https://crontab.guru/)
- [Queue Service](https://docs.objectstack.ai/docs/kernel/runtime-services/queue-service)
- [Queue Service](https://objectstack.ai/docs/kernel/runtime-services/queue-service)
2 changes: 1 addition & 1 deletion packages/services/service-knowledge/README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,7 +5,7 @@ Orchestrator implementing `IKnowledgeService` over pluggable
— that's the job of adapter plugins (`knowledge-memory`,
`knowledge-ragflow`, …).

See [Knowledge Protocol](https://docs.objectstack.ai/docs/protocol/knowledge).
See [Knowledge Protocol](https://objectstack.ai/docs/protocol/knowledge).

## License

Expand Down
Loading
Loading