Skip to content

docs(data): name currencyConfig.homeAmount on field-types, validation-rules and objectql schema pages - #28374

Merged
objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/project-thread-8h9evx
Oct 31, 2026
Merged

objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/project-thread-8h9evx

Conversation

@objectstack-fleet

Copy link
Copy Markdown
Contributor

Requested by Sam · project thread
Fixes #28330

Clause-②: no
Metadata-protocol: none

维护者速读

  • 改了什么:三篇手写文档(field-types、validation-rules、objectql schema)的 currencyConfig 说明补上第四个键 homeAmount。
  • 为什么改:homeAmount 已随 spec 发布、currency.mdx 也已重写,这三页仍只列三个旧键,读者不知道有本币折算投影。
  • 风险与回滚:仅文档,无发布面;回滚即 revert 本 PR。
  • 先看:content/docs/data-modeling/field-types.mdx(新增表格行),validation-rules.mdx(两处),protocol/objectql/schema.mdx(一行)。
  • 两分钟验证:git grep -n homeAmount -- content/docs/data-modeling/field-types.mdx content/docs/data-modeling/validation-rules.mdx content/docs/protocol/objectql/schema.mdx,预期 4 处命中,均链接 currency#declaring-the-home-amount。
  • 需要你做的:无,席位落地。

What changes

Each of the three pages now names all four CurrencyConfigSchema keys (currencyMode, defaultCurrency, currencyField, homeAmount), with homeAmount pointing at the "Declaring the home amount" section of currency.mdx for its shape:

  • content/docs/data-modeling/field-types.mdx: new currencyConfig.homeAmount row in the currency property table.
  • content/docs/data-modeling/validation-rules.mdx: new currencyConfig.homeAmount row in the currency table; the per-type summary row now lists the four keys.
  • content/docs/protocol/objectql/schema.mdx: the currencyConfig row names homeAmount beside currencyField under record.

The wording follows HomeAmountSchema and the homeAmount describe in packages/spec/src/data/field.zod.ts and main's currency.mdx: record mode only and optional there, refused under dynamic and fixed; three required pointers into the same object: field (a dynamic-mode currency field, readonly: true), rateDate (a date or datetime field) and rateField (a number field, readonly: true).

Tests

Docs only. No package source changes, so no package tests are owed.

Acceptance notes

None.

Verification

dispatch-gates derived set, run at 1e8672f

node scripts/pm/dispatch-gates.mjs --commands --repo objectstack-ai/objectstack derived 43 commands; all 43 exited 0 (check:skill-examples first refused with exit 3 because @objectstack/client-react was unbuilt, then exited 0 after building it). Reconciliation: dispatch-gates --ran: 43 derived famil(ies) accounted for — 43 run, 0 NOT-MEASURED (a DERIVED zero — all 43 recorded an exit code and none of them is 3).


Generated by Claude Code

…-rules and objectql schema pages

Each page now lists all four currencyConfig keys, with homeAmount
pointing at currency.mdx's 'Declaring the home amount' section for its
shape (field, rateDate as date/datetime, rateField as number).

Claude-Session: https://claude.ai/code/session_01QUs3BtCUdWfucAb3edvUF2
Co-authored-by: Claude <noreply@anthropic.com>
@objectstack-fleet objectstack-fleet Bot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Oct 31, 2026
@github-actions github-actions Bot added size/xs documentation Improvements or additions to documentation labels Oct 31, 2026
@objectstack-fleet

Copy link
Copy Markdown
Contributor Author

domain:devx#1 · os-zhuang · session_01QUs3BvP5Aq9USg5GtmgAAR

席位核对 — ACCEPT · domain:devx#1 · head 1e8672f6b388fa1cdabb4d769dab49c70b924842 · 2026-10-31T07:17Z

Checked against GitHub and the PR head, not against the report (os-dev-report 6540477806 on #28330).

  • Shape: draft → main, Fixes #28330, no other closing keyword, no assignees or reviewers. skip-changeset correct: content/docs only, no published package.
  • Path surface: the three claimed pages only (+4/−2). check-governed-merges: NOT governed. No content/docs/releases/ change.
  • Sentence check against the schema (HomeAmountSchema and the homeAmount describe in packages/spec/src/data/field.zod.ts on main): record only and optional; refused under dynamic and fixed; three required pointers on the same object; field a dynamic-mode currency field declaring readonly: true; rateDate a date or datetime field; rateField a number field declaring readonly: true; home currency = the localization.currency setting. Every added sentence in all three pages matches. The validation-rules summary row now names the four keys CurrencyConfigSchema holds.
  • Link: /docs/data-modeling/currency#declaring-the-home-amount resolves to ### Declaring the home amount in main's currency.mdx (PR feat(objectql): store a record-mode amount converted into the home currency on every write (multi-currency M2-2) #28302's rewrite).
  • Accepted deviation: pushed from a worktree branch to the platform branch; the PR head is the claimed branch.
  • Landing: non-governed; seat landing authorised by the maintainer (2026-10-31T06:58Z); lands once every check on this head is green.

@objectstack-fleet
objectstack-fleet Bot marked this pull request as ready for review October 31, 2026 07:25
@objectstack-fleet
objectstack-fleet Bot enabled auto-merge October 31, 2026 07:25
@objectstack-fleet
objectstack-fleet Bot added this pull request to the merge queue Oct 31, 2026
Merged via the queue into main with commit 0f29a88 Oct 31, 2026
50 checks passed
@objectstack-fleet
objectstack-fleet Bot deleted the claude/project-thread-8h9evx branch October 31, 2026 07:40
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/xs skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: three pages list currencyConfig without homeAmount (field-types, validation-rules, objectql schema)

1 participant