Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tree document #608

Merged
merged 11 commits into from
Aug 25, 2023
Merged

Add tree document #608

merged 11 commits into from
Aug 25, 2023

Conversation

MoonGyu1
Copy link
Contributor

@MoonGyu1 MoonGyu1 commented Aug 16, 2023

What this PR does / why we need it:

  • Write a document about concurrent tree editing to maintain a specification
  • The core table of contents is as follows:
  1. XML-like Tree
  • Edit/Style Operations
  1. Implementation of Edit Operation
  • Tree Coordinate System
  • Tree.Edit Logic
  1. How to Guarantee Eventual Consistency
  • Coverage
  • How does it work

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

Does this PR introduce a user-facing change?:


Additional documentation:


Checklist:

  • Added relevant tests or not required
  • Didn't break anything

@MoonGyu1 MoonGyu1 marked this pull request as draft August 16, 2023 06:39
@codecov
Copy link

codecov bot commented Aug 16, 2023

Codecov Report

Merging #608 (2691c5f) into main (21b3afc) will decrease coverage by 1.49%.
Report is 11 commits behind head on main.
The diff coverage is 48.81%.

@@            Coverage Diff             @@
##             main     #608      +/-   ##
==========================================
- Coverage   50.89%   49.41%   -1.49%     
==========================================
  Files          69       69              
  Lines        7167     9914    +2747     
==========================================
+ Hits         3648     4899    +1251     
- Misses       3035     4501    +1466     
- Partials      484      514      +30     
Files Changed Coverage Δ
api/converter/to_pb.go 52.63% <0.00%> (-2.62%) ⬇️
pkg/document/internal_document.go 15.34% <0.00%> (+1.66%) ⬆️
server/rpc/admin_server.go 50.00% <0.00%> (-3.98%) ⬇️
client/client.go 13.58% <8.33%> (+0.09%) ⬆️
api/converter/to_bytes.go 57.37% <15.78%> (-5.57%) ⬇️
api/converter/from_pb.go 42.12% <20.45%> (-6.88%) ⬇️
pkg/document/crdt/tree.go 52.49% <53.95%> (-2.89%) ⬇️
pkg/index/tree.go 56.30% <69.35%> (+7.45%) ⬆️
server/rpc/yorkie_server.go 50.52% <92.85%> (-6.31%) ⬇️

... and 60 files with indirect coverage changes

@krapie krapie requested a review from hackerwins August 17, 2023 15:21
@krapie krapie added the documentation 📔 Improvements or additions to documentation label Aug 17, 2023
@hackerwins
Copy link
Member

@MoonGyu1 Could you merge the main branch here?

@MoonGyu1 MoonGyu1 force-pushed the concurrent-tree-editing-docs branch from e0e7b17 to ffed1e7 Compare August 25, 2023 02:39
Copy link
Member

@hackerwins hackerwins left a comment

Choose a reason for hiding this comment

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

I left a comment on the term.

design/concurrent-tree-editing.md Outdated Show resolved Hide resolved
Copy link
Member

@hackerwins hackerwins left a comment

Choose a reason for hiding this comment

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

I left a minor comment about the title.

design/concurrent-tree-editing.md Outdated Show resolved Hide resolved
@MoonGyu1 MoonGyu1 marked this pull request as ready for review August 25, 2023 08:59
Copy link
Member

@hackerwins hackerwins left a comment

Choose a reason for hiding this comment

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

I left one more minor comment.

design/tree.md Outdated Show resolved Hide resolved
@hackerwins hackerwins merged commit 41f457c into main Aug 25, 2023
1 check passed
@hackerwins hackerwins deleted the concurrent-tree-editing-docs branch August 25, 2023 09:16
@hackerwins hackerwins changed the title Write concurrent tree editing document Add tree document Aug 25, 2023
@krapie
Copy link
Member

krapie commented Aug 26, 2023

It seems like the tree document link is missing in README.md in the design document.
I will update this on #630

Wu22e pushed a commit to Wu22e/yorkie that referenced this pull request Sep 3, 2023
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants