Skip to content

Add SharedTree library overview and feature comparison#3

Draft
noencke wants to merge 3 commits into
mainfrom
best-tree
Draft

Add SharedTree library overview and feature comparison#3
noencke wants to merge 3 commits into
mainfrom
best-tree

Conversation

@noencke
Copy link
Copy Markdown
Owner

@noencke noencke commented May 13, 2026

This document introduces the SharedTree library, detailing its features and comparing them with various frameworks. It highlights aspects such as state machine replication, storage, data migration, and more.

How contribute to this repo.

Guidelines for Pull Requests.

The sections included below are suggestions for what you may want to include.
Feel free to remove or alter parts of this template that do not offer value for your specific change.

Description

A concise description of the changes (bug or feature) and their impact/motivation.
If this description is short enough to be used as the title, delete this section and just use the title.

For bug fixes, also include specifics of how to reproduce it / confirm it is fixed.

If this Pull Request should close/resolve any issues when merged, use the special syntax for that here.

Breaking Changes

If this introduces a breaking change, please describe the impact and migration path for existing applications below.
See Breaking-vs-Non-breaking-Changes for details.
If there are no breaking changes, delete this section.

Reviewer Guidance

The review process is outlined on this wiki page.

List any specific things you want to get reviewer opinions on, and anything a reviewer would need to know to review this PR effectively.
Things you might want to include:

  • Questions about how to properly make automated tests for your changes.
  • Questions about design choices you made.
  • Descriptions of how to manually test the changes (and how much of that you have done).
  • etc.

If you have any questions in this section, consider making the PR a draft until all questions have been resolved.

This document introduces the SharedTree library, detailing its features and comparing them with various frameworks. It highlights aspects such as state machine replication, storage, data migration, and more.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 13, 2026

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

Based on the diff (296 lines, 1 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

noencke added 2 commits May 13, 2026 16:03
Expanded the document to provide a comprehensive overview of the Fluid Framework and SharedTree, detailing features, comparisons with other frameworks, and compliance aspects.
Refactor and enhance the Fluid Framework section, improving clarity and structure. Update features and compliance details for better comparison with other frameworks.
@noencke noencke closed this May 14, 2026
@noencke noencke reopened this May 14, 2026
@github-actions
Copy link
Copy Markdown

🔗 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


Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant