Skip to content

docs(tree): tweaks to constraint docs#27309

Merged
yann-achard-MS merged 2 commits into
microsoft:mainfrom
yann-achard-MS:constraint-doc-tweaks
May 14, 2026
Merged

docs(tree): tweaks to constraint docs#27309
yann-achard-MS merged 2 commits into
microsoft:mainfrom
yann-achard-MS:constraint-doc-tweaks

Conversation

@yann-achard-MS
Copy link
Copy Markdown
Contributor

Description

Tweaks to constraint docs in the follow up to #26763.

Breaking Changes

None

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 13, 2026

Hi! Thank you for opening this PR. Want me to review it?

Based on the diff (25 lines, 2 files), I've queued these reviewers:

  • Correctness — logic errors, race conditions, lifecycle issues
  • Security — vulnerabilities, secret exposure, injection
  • API Compatibility — breaking changes, release tags, type design
  • Performance — algorithmic regressions, memory leaks
  • Testing — coverage gaps, hollow tests

How this works

  • Adjust the reviewer set by ticking/unticking boxes above. Reviewer toggles alone don't trigger anything.

  • Tick Start review below to dispatch the review fleet.

  • After review finishes, tick Start review again to request another run — it auto-resets after each dispatch.

  • This comment updates as new commits land; your reviewer selections are preserved.

  • Start review

@yann-achard-MS yann-achard-MS marked this pull request as ready for review May 13, 2026 23:46
@yann-achard-MS yann-achard-MS requested a review from a team as a code owner May 13, 2026 23:46
Copilot AI review requested due to automatic review settings May 13, 2026 23:46
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Tweaks SharedTree transaction constraint documentation (follow-up to #26763) to better explain when constraints are evaluated and to clarify the intended semantics of the noChange constraint, plus a small related comment update in delta utilities.

Changes:

  • Add a note explaining how/when constraint violations are settled across clients (optimistic local application vs. post-sequencing reconciliation).
  • Refine noChange constraint documentation to emphasize whole-document equality and describe “canceling out” concurrent edits.
  • Update deltaUtil doc comments to describe “visible changes” in terms of attach/detach.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
packages/dds/tree/src/core/tree/deltaUtil.ts Updates JSDoc wording for “visible changes” detection helpers.
docs/docs/data-structures/tree/transactions.mdx Expands constraint timing explanation; refines noChange constraint docs and examples.

Comment thread docs/docs/data-structures/tree/transactions.mdx Outdated
Comment thread docs/docs/data-structures/tree/transactions.mdx Outdated
@github-actions
Copy link
Copy Markdown
Contributor

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  288641 links
    1922 destination URLs
    2172 URLs ignored
       0 warnings
       0 errors


@yann-achard-MS yann-achard-MS merged commit 9b89f88 into microsoft:main May 14, 2026
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants