Skip to content

docs: align setup and agent guides with live contracts - #1643

Merged
Eldad-Caura merged 1 commit into
mainfrom
fix-oss-documentation-drift
Sep 20, 2026
Merged

docs: align setup and agent guides with live contracts#1643
Eldad-Caura merged 1 commit into
mainfrom
fix-oss-documentation-drift

Conversation

@Eldad-Caura

@Eldad-Caura Eldad-Caura commented Sep 19, 2026

Copy link
Copy Markdown
Member

Summary

  • align manual-install, authentication, Docker, and database setup guidance with the current services
  • correct fleet upgrade, trust-scope, document-search, keystone, memory-type, and bulk-write contracts
  • remove references to the nonexistent bundled OSS web UI and fix the Python client error example

Audit findings

Addresses these Erni-owned findings from the audit tracker:

  • oss-0902-m-03
  • oss-0902-m-04
  • oss-0902-m-71
  • oss-0814-m-26
  • oss-0902-m-79
  • oss-0902-m-80
  • oss-0902-m-81
  • oss-0902-l-07
  • oss-0902-l-01
  • oss-0902-l-02
  • oss-0902-l-03
  • oss-0902-l-62
  • oss-0902-l-63
  • oss-0902-l-65

Validation

  • 10 direct served-skill regression checks passed
  • 18 direct install-skill regression checks passed
  • 8 direct quickstart exposure checks passed
  • docker compose config -q
  • git diff --check

The targeted pytest invocation could not initialize its session fixture because the local PostgreSQL instance does not contain the required caura_test database; no test assertion ran or failed.

@Eldad-Caura
Eldad-Caura requested a review from a team as a code owner September 19, 2026 23:42
@github-actions

This comment has been minimized.

Sign in to view
@Eldad-Caura

Eldad-Caura commented Sep 19, 2026

Copy link
Copy Markdown
Member Author

Review finding declined after verification: env.dev is the correct filename.

Both docker-compose.yml:149 and docker-compose.dev.yml:121 explicitly load env.dev through env_file; .env.dev is not the Compose env-file name in this repository. The documentation change intentionally fixes audit finding oss-0902-l-02, so no code change is needed.

@Eldad-Caura

Eldad-Caura commented Sep 19, 2026

Copy link
Copy Markdown
Member Author

@erni-a

@Eldad-Caura
docs: align setup and agent guides with live contracts
f38d48b 
Signed-off-by: Eldad Caura <eldad@caura.ai>
@Eldad-Caura
Eldad-Caura force-pushed the fix-oss-documentation-drift branch from b4c9d68 to f38d48b Compare September 20, 2026 00:18
@Eldad-Caura
Eldad-Caura merged commit c52d517 into main Sep 20, 2026
15 checks passed
@Eldad-Caura
Eldad-Caura deleted the fix-oss-documentation-drift branch September 20, 2026 00:19
@caura-deploy-bot caura-deploy-bot Bot mentioned this pull request Sep 20, 2026
Merged
Eldad-Caura pushed a commit that referenced this pull request Sep 23, 2026
@caura-deploy-bot
chore: release main (#1644)
8e9d33b 
🤖 I have created a release *beep* *boop*
---


<details><summary>backend: 3.18.0</summary>

##
[3.18.0](backend-v3.17.2...backend-v3.18.0)
(2026-09-23)


### Features

* add dual-read service agent identities (step 1)
([#1676](#1676))
([1d8d55e](1d8d55e))
* **api:** resolve tenant_id from the credential when a body omits it
([#1634](#1634))
([f496b27](f496b27))
* **clients:** hold the memclaw-client name as a truthful redirect shell
(0.5.1) ([#1646](#1646))
([5e2a3a9](5e2a3a9))
* **contradiction:** treat provenance and containment as single-valued
([#1678](#1678))
([352f616](352f616))
* **documents:** record which agent wrote a document
([#1652](#1652))
([1989376](1989376))
* **enrichment:** make the atomic-fact fan-out switchable per tenant
([#1677](#1677))
([4ab590f](4ab590f))
* **mcp:** bill the batch write, and count the verdicts nobody could
determine ([#1675](#1675))
([0f3fd2b](0f3fd2b))


### Bug Fixes

* **agents:** confirm a lookup miss against the primary before creating
([#1647](#1647))
([88e8a1b](88e8a1b))
* **agents:** read the agent back from the primary after writing it
([#1641](#1641))
([2334d19](2334d19))
* **api:** give an unmatched route the error envelope, and name the real
ones ([#1636](#1636))
([c297e0e](c297e0e))
* **api:** let an agent credential's own identity fill an omitted
agent_id (ax-0917-m-16)
([#1696](#1696))
([9311e43](9311e43))
* **api:** make the request-budget 504 readable instead of
`{"detail":...}`
([#1633](#1633))
([fe096f7](fe096f7))
* **api:** retire legacy service agent ids (step 3)
([#1694](#1694))
([c944bec](c944bec))
* **api:** stop the plan quota from squatting on X-RateLimit-*
([#1679](#1679))
([6242aba](6242aba))
* **c-04:** make the worker-path test able to fail, and close the
review's remainder
([#1682](#1682))
([4c0b3bb](4c0b3bb))
* **extraction:** stop two surface forms clobbering each other's aliases
(09/02 L-32) ([#1681](#1681))
([9e57349](9e57349))
* **idempotency:** record the key even when the caller disconnects
(ax-0917-h-09) ([#1629](#1629))
([33e9692](33e9692))
* **memories:** make the expiry sweep cover expires_at (09/02 M-60)
([#1692](#1692))
([6230230](6230230))
* **sentinel:** point the memory-id stuffing check at the field Forge
writes (09/02 L-35)
([#1541](#1541))
([3a5fccd](3a5fccd))
* **storage:** migrate legacy service agent ids (step 2)
([#1683](#1683))
([f664d86](f664d86))
* **storage:** report schema drift at startup
([#1655](#1655))
([8bf3012](8bf3012))
* **storage:** stop 044's post-condition claiming harm it does not cause
([#1684](#1684))
([64b3f54](64b3f54))


### Performance

* **extraction:** upsert relations concurrently instead of one POST at a
time (09/02 L-37)
([#1543](#1543))
([f99f7bf](f99f7bf))
* **recall:** stop shipping the result set twice and the telemetry three
times ([#1557](#1557))
([9e7c3bc](9e7c3bc))


### Dependencies

* **actions:** bump the actions group with 6 updates
([#1663](#1663))
([c985da4](c985da4))
* **clients:** bump @types/node from 26.5.1 to 26.6.1 in
/clients/typescript in the clients-npm-minor-patch group across 1
directory ([#1664](#1664))
([58dc455](58dc455))
* **clients:** update ruff requirement from &lt;0.16,&gt;=0.15.4 to
&gt;=0.15.4,&lt;0.17 in /clients/python
([#1576](#1576))
([e56ac7e](e56ac7e))
* **docker:** bump datadog/serverless-init from `2f498f4` to `f494334`
in /core-api ([#1563](#1563))
([ccbf60b](ccbf60b))
* **docker:** bump datadog/serverless-init from `2f498f4` to `f494334`
in /core-operations
([#1564](#1564))
([5dbe7fb](5dbe7fb))
* **docker:** bump datadog/serverless-init from `2f498f4` to `f494334`
in /core-worker ([#1565](#1565))
([04f6b7b](04f6b7b))
* **plugin:** bump @types/node from 26.5.1 to 26.6.1 in /plugin in the
npm-minor-patch group
([#1658](#1658))
([b4c43f2](b4c43f2))
* update cachetools requirement from &gt;=7.1.8 to &gt;=7.2.0
([#1661](#1661))
([273ac33](273ac33))
* update google-cloud-aiplatform requirement from &lt;3,&gt;=2.1.0 to
&gt;=2.1.3,&lt;3
([#1660](#1660))
([140a67a](140a67a))
* update httpx requirement from &lt;1,&gt;=0.27 to &gt;=0.28.1,&lt;1
([#1566](#1566))
([b3bd76d](b3bd76d))
* update python-dateutil requirement from &lt;3,&gt;=2.8 to
&gt;=2.9.0.post0,&lt;3
([#1567](#1567))
([1871882](1871882))
* update sentry-sdk requirement from &lt;3,&gt;=2.69.1 to
&gt;=2.69.2,&lt;3
([#1662](#1662))
([bd4135e](bd4135e))
* update uvicorn requirement from &lt;1,&gt;=0.52.4 to &gt;=0.53.0,&lt;1
([#1659](#1659))
([71c48de](71c48de))


### Reverts

* "fix(storage): apply the cross-link threshold outside the LIMIT"
([#1639](#1639))
([c06f215](c06f215))


### Documentation

* align setup and agent guides with live contracts
([#1643](#1643))
([c52d517](c52d517))
* **api:** correct the fleet-less recall claim and name all four scope
axes (ax-0917-m-19/m-20)
([#1697](#1697))
([8b235f7](8b235f7))
* **documents:** disclose that a doc write mints a memory (ax-0917-m-15)
([#1695](#1695))
([005e607](005e607))
* **rebrand:** classify remaining legacy names
([#1674](#1674))
([0d2d077](0d2d077))
* **rebrand:** classify skill and migration legacy names
([#1671](#1671))
([87f9bde](87f9bde))
* **search:** six cosine renders were two evaluations per row, not six
([#1685](#1685))
([e31b18c](e31b18c))
</details>

<details><summary>plugin: 2.23.1</summary>

##
[2.23.1](plugin-v2.23.0...plugin-v2.23.1)
(2026-09-23)


### Dependencies

* **plugin:** bump @types/node from 26.5.1 to 26.6.1 in /plugin in the
npm-minor-patch group
([#1658](#1658))
([b4c43f2](b4c43f2))


### Documentation

* align setup and agent guides with live contracts
([#1643](#1643))
([c52d517](c52d517))
* **api:** correct the fleet-less recall claim and name all four scope
axes (ax-0917-m-19/m-20)
([#1697](#1697))
([8b235f7](8b235f7))
* **documents:** disclose that a doc write mints a memory (ax-0917-m-15)
([#1695](#1695))
([005e607](005e607))
* **rebrand:** classify skill and migration legacy names
([#1671](#1671))
([87f9bde](87f9bde))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Signed-off-by: release-please[bot] <release-please[bot]@users.noreply.github.com>
Signed-off-by: Eldad Caura <eldad@caura.ai>
Co-authored-by: caura-deploy-bot[bot] <265395343+caura-deploy-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@erni-a erni-a erni-a approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Eldad-Caura @erni-a