Add glossary to docs #162
Add glossary to docs #162
Conversation
|
Warning Rate limit exceeded@hackerwins has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 0 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughA glossary for the Yorkie project has been introduced, containing definitions for key terms relevant to the project and its community. The glossary is organized into categories such as "Core," "Network," and "CRDT," with concise descriptions for each term, enhancing the overall documentation. Changes
Assessment against linked issues
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (3)
docs/glossary.mdx (3)
13-13: Clarify the term "Client".Consider specifying "regular client" to "a client application" for better clarity.
Apply this diff for improved clarity:
- An regular client that communicates with the Yorkie server, synchronizing document changes for real-time collaboration. + A client application that communicates with the Yorkie server, synchronizing document changes for real-time collaboration.
18-18: Add a space after 'structure'.Add a space between "data structure" and "(CRDT)" for consistency.
Apply this diff for consistency:
- The main JSON-like data structure(CRDT) within a document that can be shared and edited by multiple users. + The main JSON-like data structure (CRDT) within a document that can be shared and edited by multiple users.
24-24: Clarify the term "CRDT Node".Consider providing examples of CRDT nodes for better understanding.
Apply this diff to clarify:
- A single node within a CRDT element(Text, Tree). + A single node within a CRDT element, such as Text or Tree.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/glossary.mdx (1 hunks)
Additional context used
LanguageTool
docs/glossary.mdx
[grammar] ~7-~7: The singular determiner ‘this’ may not agree with the plural noun ‘words’. Did you mean “these”?
Context: ...'Glossary' order: 100 --- ## Glossary This words are used in the Yorkie project an...(THIS_NNS)
Additional comments not posted (1)
docs/glossary.mdx (1)
1-4: Metadata section looks good.The title and order metadata are appropriate for the glossary.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/glossary.mdx (1 hunks)
Additional context used
LanguageTool
docs/glossary.mdx
[grammar] ~7-~7: The singular determiner ‘this’ may not agree with the plural noun ‘words’. Did you mean “these”?
Context: ...'Glossary' order: 100 --- ## Glossary This words are used in the Yorkie project an...(THIS_NNS)
Additional comments not posted (3)
docs/glossary.mdx (3)
6-8: Correct the grammatical error in the introduction.Replace "This words" with "These words" to ensure subject-verb agreement.
Tools
LanguageTool
[grammar] ~7-~7: The singular determiner ‘this’ may not agree with the plural noun ‘words’. Did you mean “these”?
Context: ...'Glossary' order: 100 --- ## Glossary This words are used in the Yorkie project an...(THIS_NNS)
10-26: Glossary table is well-written.The glossary entries provide clear and concise definitions for each term.
30-30: Contribution note is clear and encouraging.The note provides clear instructions for adding new words to the glossary.
This commit adds a glossary to the documentation, providing definitions for key terms used in the Yorkie project and community. This addition will help users better understand the terminology used in the project.
What this PR does / why we need it?
Add glossary to docs
This commit adds a glossary to the documentation, providing definitions for key terms used in the Yorkie project and community. This addition will help users better understand the terminology used in the project.
Any background context you want to provide?
What are the relevant tickets?
Fixes #161
Checklist
Summary by CodeRabbit