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

docs: increase precision of TIA Allocation at Genesis #1699

Merged
merged 3 commits into from
Sep 11, 2024

Conversation

rootulp
Copy link
Contributor

@rootulp rootulp commented Sep 6, 2024

Increase precision of the table under TIA Allocation at Genesis. Also updates the graphic, thanks Alina!

Summary by CodeRabbit

  • Documentation
    • Enhanced the clarity and consistency of the staking-governance-supply document by adjusting numerical values in tables to two decimal places.
    • Reformatted table headers for improved spacing and alignment, resulting in a cleaner presentation.

@rootulp rootulp self-assigned this Sep 6, 2024
Copy link
Contributor

coderabbitai bot commented Sep 6, 2024

Walkthrough

The changes involve formatting and content adjustments in the learn/staking-governance-supply.md document. Key modifications include the enhancement of numerical precision in tables, specifically by increasing decimal places for certain percentage values. Additionally, table headers have been reformatted for improved alignment and consistency, while the overall structure and informational content of the document remain unchanged.

Changes

File Path Change Summary
learn/staking-governance-supply.md Adjusted numerical precision in tables, changing percentage values to two decimal places; reformatted table headers for uniformity.

Sequence Diagram(s)

(No diagrams generated as the changes are primarily cosmetic and do not involve new features or control flow modifications.)

Poem

🐰 In the garden where numbers play,
Precision blooms in a bright array.
With headers neat and values clear,
We hop with joy, for change is here!
A table tidy, a sight to see,
Oh, what fun for you and me! 🌼

Tip

Announcements
  • The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
  • We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
  • Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
  • Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
  • Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4b1d38f and bf4c379.

Files ignored due to path filters (1)
  • public/img/learn/Celestia_TIA_Allocation_at_Genesis.png is excluded by !**/*.png
Files selected for processing (1)
  • learn/staking-governance-supply.md (3 hunks)
Additional context used
LanguageTool
learn/staking-governance-supply.md

[uncategorized] ~109-~109: The preposition “in” seems more likely in this position than the preposition “at”.
Context: ...y Backers: Seed | 33.33% unlocked at year 1.
Remaining 66.67% unlocks co...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_AT_IN)


[uncategorized] ~110-~110: The preposition “in” seems more likely in this position than the preposition “at”.
Context: ...y Backers: Series A&B | 33.33% unlocked at year 1.
Remaining 66.67% unlocks co...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_AT_IN)

Additional comments not posted (1)
learn/staking-governance-supply.md (1)

75-81: Enhanced precision in TIA allocation table.

The changes to the TIA allocation table, specifically the addition of decimal places to the percentage values, enhance the precision and clarity of the documentation. This aligns with the PR's objective to provide more accurate information regarding the allocation of tokens at the genesis block.

The formatting changes, such as the alignment and spacing adjustments, contribute to a cleaner presentation and improved readability. These changes are beneficial and should be maintained.


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented Sep 6, 2024

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1699/
on branch main at 2024-09-10 18:14 UTC

@rootulp rootulp closed this Sep 6, 2024
@rootulp rootulp reopened this Sep 6, 2024
@rootulp rootulp marked this pull request as ready for review September 6, 2024 17:08
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d7668f1 and 4b1d38f.

Files selected for processing (1)
  • learn/staking-governance-supply.md (3 hunks)
Files skipped from review due to trivial changes (1)
  • learn/staking-governance-supply.md

@rootulp
Copy link
Contributor Author

rootulp commented Sep 6, 2024

Moving to draft until we confirm the spreadsheet that these changes are based on is correct.

@rootulp rootulp marked this pull request as draft September 6, 2024 18:15
| R&D & Ecosystem | Tokens allocated to the Celestia Foundation and core devs for research, development, and ecosystem initiatives including:<br/>- Protocol maintenance and development<br/>- Programs for rollup developers, infrastructure, and node operators | 26.87% |
| Early Backers: Series A&B | Early supporters of Celestia | 19.67% |
| Early Backers: Seed | Early supporters of Celestia | 15.90% |
| Initial Core Contributors | Members of Celestia Labs, the first core contributor to Celestia | 17.56% |
Copy link
Member

Choose a reason for hiding this comment

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

lgtm, adds up to 100%

Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

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

lgtm

@rootulp rootulp changed the title docs: increase precision of token distribution docs: increase precision of TIA Allocation at Genesis Sep 10, 2024
Copy link
Member

@jcstein jcstein left a comment

Choose a reason for hiding this comment

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

requesting changes as need to ask Alina for diagram once final #s are set

@rootulp rootulp marked this pull request as ready for review September 10, 2024 18:14
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4b1d38f and bf4c379.

Files ignored due to path filters (1)
  • public/img/learn/Celestia_TIA_Allocation_at_Genesis.png is excluded by !**/*.png
Files selected for processing (1)
  • learn/staking-governance-supply.md (3 hunks)
Additional context used
LanguageTool
learn/staking-governance-supply.md

[uncategorized] ~109-~109: The preposition “in” seems more likely in this position than the preposition “at”.
Context: ...y Backers: Seed | 33.33% unlocked at year 1.
Remaining 66.67% unlocks co...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_AT_IN)


[uncategorized] ~110-~110: The preposition “in” seems more likely in this position than the preposition “at”.
Context: ...y Backers: Series A&B | 33.33% unlocked at year 1.
Remaining 66.67% unlocks co...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_AT_IN)

Additional comments not posted (1)
learn/staking-governance-supply.md (1)

75-81: Enhanced precision in TIA allocation table.

The changes to the TIA allocation table, specifically the addition of decimal places to the percentage values, enhance the precision and clarity of the documentation. This aligns with the PR's objective to provide more accurate information regarding the allocation of tokens at the genesis block.

The formatting changes, such as the alignment and spacing adjustments, contribute to a cleaner presentation and improved readability. These changes are beneficial and should be maintained.

Comment on lines +104 to +110
| Category | Unlock Schedule |
|---------------------------|---------------------------------------------------------------------------------------------|
| Public Allocation | Fully unlocked at launch. |
| R&D & Ecosystem | 25.00% unlocked at launch.<br/>Remaining 75.00% unlocks continuously from year 1 to year 4. |
| Initial Core Contributors | 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 3. |
| Early Backers: Seed | 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2. |
| Early Backers: Series A&B | 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Unlock schedule table updates are clear and informative.

The updates to the unlock schedule table are clear and provide detailed information about the unlocking of tokens across different categories. This is crucial for understanding the distribution and availability of tokens over time.

However, there are minor grammatical suggestions from the static analysis tool regarding the preposition used in the unlock schedule descriptions for "Early Backers: Seed" and "Early Backers: Series A&B". It suggests using "in" instead of "at" for better grammatical accuracy.

Consider applying these grammatical corrections:

- 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2.
+ 33.33% unlocked in year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2.

- 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2.
+ 33.33% unlocked in year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Category | Unlock Schedule |
|---------------------------|---------------------------------------------------------------------------------------------|
| Public Allocation | Fully unlocked at launch. |
| R&D & Ecosystem | 25.00% unlocked at launch.<br/>Remaining 75.00% unlocks continuously from year 1 to year 4. |
| Initial Core Contributors | 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 3. |
| Early Backers: Seed | 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2. |
| Early Backers: Series A&B | 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2. |
| Category | Unlock Schedule |
|---------------------------|---------------------------------------------------------------------------------------------|
| Public Allocation | Fully unlocked at launch. |
| R&D & Ecosystem | 25.00% unlocked at launch.<br/>Remaining 75.00% unlocks continuously from year 1 to year 4. |
| Initial Core Contributors | 33.33% unlocked at year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 3. |
| Early Backers: Seed | 33.33% unlocked in year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2. |
| Early Backers: Series A&B | 33.33% unlocked in year 1.<br/>Remaining 66.67% unlocks continuously from year 1 to year 2. |
Tools
LanguageTool

[uncategorized] ~109-~109: The preposition “in” seems more likely in this position than the preposition “at”.
Context: ...y Backers: Seed | 33.33% unlocked at year 1.
Remaining 66.67% unlocks co...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_AT_IN)


[uncategorized] ~110-~110: The preposition “in” seems more likely in this position than the preposition “at”.
Context: ...y Backers: Series A&B | 33.33% unlocked at year 1.
Remaining 66.67% unlocks co...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_AT_IN)

@rootulp rootulp merged commit da0bece into main Sep 11, 2024
5 checks passed
@rootulp rootulp deleted the rp/increase-precision branch September 11, 2024 07:41
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.

2 participants