Update data glossary #1651
Update data glossary #1651
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Rate limit exceeded@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 9 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. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe changes consist of a comprehensive revision to the data glossary documentation for the Superchain ecosystem. The updates include expanded and clarified definitions, standardized terminology, detailed calculation formulas, and improved formatting for readability. New sections organize metrics into categories such as onchain activity, network usage, user experience, and market position. Each metric now features a clear definition, calculation method, contextual notes, and explanation of significance. A summary table of all metrics is added at the end. Separately, the word "outperformance" was removed from a word list file, with no other modifications. Possibly related PRs
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (1)
194-202: Standardize metric name casingMetric names in the summary table use Title Case (e.g., “Real Economic Value”) while the detailed sections use sentence case (e.g., “Real economic value”). Please align the naming convention across the document—either convert the detailed metric headings to Title Case or adjust the summary table entries to sentence case—for consistency.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(2 hunks)words.txt(0 hunks)
💤 Files with no reviewable changes (1)
- words.txt
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[duplication] ~78-~78: Possible typo: you repeated a word.
Context: ... * from address = batcherHash address * to address = batchInbox address * Both def...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (1)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (1)
1-13: Frontmatter complete and valid metadataThe frontmatter includes all required fields (title, lang, description, topic, personas, categories, content_type) for a guide page and they are all non-empty.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (2)
17-17: Use active voice and remove filler language
The intro is a bit verbose. Consider simplifying to something like:
“This glossary will be updated as new metrics emerge or definitions evolve and includes each metric’s definition, calculation, and ecosystem significance.”
53-63: Use sentence case for “onchain”
“Onchain” isn’t a proper noun here and should be lowercased in “net onchain profit” for consistency with sentence-case style.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[duplication] ~78-~78: Possible typo: you repeated a word.
Context: ... * from address = batcherHash address * to address = batchInbox address * Both def...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
I've revert some changes. Capitalization changes follow our style guide requirements(Sentence case for headers). |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (3)
33-33: Consistent sentence casing in note
Change “Out-Of-Protocol” to “Out-of-protocol” to adhere to sentence case in body content.
92-92: Inconsistent capitalization of DefiLlama
Line 33 uses “Defillama’s” while line 92 uses “DefiLlama.” Please standardize to “DefiLlama.”
130-130: Replace ampersand with “and” for prose clarity
Use “Network usage and infrastructure” instead of “Network usage & infrastructure.”
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ... * from address = batcherHash address * to address = batchInbox address * Both are...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (22)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (22)
4-4: Frontmatter description update looks good
The new description is clear, concise, and follows the required frontmatter fields.
17-17: Intro paragraph is clear and follows style guidelines
Sentence case, no personal pronouns, and an Oxford comma present.
19-19: H2 header follows sentence case conventions
“Measuring demand” correctly capitalizes only the first word and preserves acronyms.
27-31: Calculation block for REV is formatted correctly
The fenced code block and formula are clear and consistent with other metrics.
35-36: “Why it matters” section is well-structured
Header and explanation follow formatting and style guidelines.
42-49: Revenue definition and calculation are clear
Bold labels, descriptive text, and fenced code block for the formula maintain consistency.
55-63: Key Components section is properly formatted
Bulleted items and nested code blocks for Net Onchain Profit and Chain Revenue are clear.
64-64: Parenthetical note is correctly styled
Italicized aside uses sentence-case and is informative.
66-68: L1 Gas Fees bullet reads well
Terminology and enumeration of sub-fee types are accurate and concise.
72-81: Transaction classification nested lists are correctly indented and verb-complete
“Both are defined…” appears in both sections, mirroring the previous refactor request.🧰 Tools
🪛 LanguageTool
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ... *fromaddress =batcherHashaddress *toaddress =batchInboxaddress * Both are...(ENGLISH_WORD_REPEAT_RULE)
86-86: H2 header “Onchain Activity Signals” follows sentence case
Proper capitalization of the acronym “Onchain” is preserved.
94-98: TVL calculation block is formatted consistently
Fenced code block correctly displays the summation formula.
106-107: “Why it matters” for TVL is succinct and informative
Follows the same structure as other metrics.
109-109: H4 header follows sentence case
“Measuring growth: Net TVL flows” correctly capitalizes only the first word and acronyms.
111-113: Net TVL flows description is clear
Explains the rationale and adjustment for price volatility succinctly.
114-117: Calculation block for Net TVL flows is well-presented
Fenced code block clearly shows the formula.
121-123: Example bullet points illustrate the concept effectively
Numeric examples and explanatory notes align with the calculation.
132-132: H3 header is sentence case and clear
“Computational demand” correctly follows header rules.
136-136: Definition for gas/s is precise and consistent
Terminology and unit phrasing are accurate.
144-144: Important Note is formatted consistently
Bold label and cautionary text match other notes.
150-150: Median Transaction Fee definition is clear
Sentence-case phrasing and context are appropriate.
186-186: Metrics summary header follows sentence case
“Metrics summary” is correctly capitalized.
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (5)
33-33: Avoid italicizing full note
The line*Note: Out-Of-Protocol tips can be sourced from Defillama's MEV category*uses full italics for emphasis. Instead, use a bold label and plain text, e.g.:
-*Note: Out-Of-Protocol tips can be sourced from Defillama's MEV category* +**Note:** Out-of-protocol tips can be sourced from DefiLlama's MEV category
51-51: Avoid italicizing special‐case callout
Replace the italicized line*Special case: OP Mainnet contributes 100% of net Onchain profit*with a bold label, e.g.:
-*Special case: OP Mainnet contributes 100% of net Onchain profit* +**Special case:** OP Mainnet contributes 100% of net onchain profit
72-82: Remove italics from footnote bullet
The bullet*Each chain's `SystemConfigProxy` contract can be found in the [Superchain Registry](/superchain/superchain-registry)*is italicized in full. Drop the surrounding
*and use plain text or bold the label only:-*Each chain's `SystemConfigProxy` contract can be found in the [Superchain Registry](/superchain/superchain-registry)* +Each chain's `SystemConfigProxy` contract can be found in the [Superchain Registry](/superchain/superchain-registry)🧰 Tools
🪛 LanguageTool
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ... *fromaddress =batcherHashaddress *toaddress =batchInboxaddress * Both are...(ENGLISH_WORD_REPEAT_RULE)
158-158: Avoid italicizing conversion note
The line*Converted to USD at transaction time*uses full italics. Replace with a bold “Note:” label or plain text, e.g.:
-*Converted to USD at transaction time* +**Note:** Converted to USD at transaction time
190-195: Inconsistent term formatting in summary table
The summary table row for REV uses “out-of-protocol tips” (lowercase) while the calculation section uses “Out-Of-Protocol Tips.” Please unify the styling (e.g., prefer “Out-of-protocol tips”) across all instances.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[duplication] ~73-~73: Possible typo: you repeated a word.
Context: ... * from address = batcherHash address * to address = batchInbox address * Both are...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (3)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (3)
4-4: Frontmatter description is present and non-empty, matching required metadata fields.
17-17: Intro paragraph is clear, follows tone and grammar guidelines.
19-19: H2 header uses correct sentence case.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (1)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (1)
69-79: Nested list indentation issues
The child bullets under Transaction classification, specifically the Transaction batches and State output submissions/dispute games entries, are not indented relative to their parent. This can break markdown rendering. Please indent nested list items by four spaces.🧰 Tools
🪛 LanguageTool
[duplication] ~70-~70: Possible typo: you repeated a word.
Context: ... *fromaddress =batcherHashaddress *toaddress =batchInboxaddress * Both are...(ENGLISH_WORD_REPEAT_RULE)
🧹 Nitpick comments (2)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (2)
141-141: Sentence-case for bold labels
Change**Important Note:** Gas is only comparable across chains that use Ethereum-equivalent gas units.to
**Important note:** Gas is only comparable across chains that use Ethereum-equivalent gas units.to maintain sentence-case consistency.
147-155: Standardize capitalization in median fee snippet & conversion note
- Lower-case "All" in the formula for consistency with sentence-case notation.
- Prefix the conversion note with a bold "Note:" for parallel structure.
@@ Median fee calculation - Median Fee = median(All transaction fees over period) + Median Fee = median(all transaction fees over period) @@ Conversion note - *Converted to USD at transaction time* + *Note:* Converted to USD at transaction time
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[duplication] ~70-~70: Possible typo: you repeated a word.
Context: ... * from address = batcherHash address * to address = batchInbox address * Both are...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: pr-workflow
🔇 Additional comments (5)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (5)
4-4: Frontmatter completeness check
The updated description is clear, imperative, free of personal pronouns, and the frontmatter now includes all required fields (title, lang, description, topic, personas, categories, content_type).
17-17: Introductory paragraph looks good
This living document notice is informative and uses sentence case appropriately.
19-19: Header sentence case verified
The H2 header "Measuring demand" follows sentence-case rules.
27-31: REV section formatting and labels
The Calculation and Why it matters labels are in sentence case, and the formula block is properly fenced and clear.Also applies to: 35-36
42-49: Revenue metric section is clear
The Definition and Calculation bullets are consistent and use sentence-case formatting correctly.
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (7)
35-35: Standardize hyphenation in note
Use sentence-case and lowercase for non-proper terms:-*Note: Out-Of-Protocol tips can be sourced from DefiLlama's MEV category* +*Note: Out-of-protocol tips can be sourced from DefiLlama's MEV category*
54-57: Sentence-case sub-metric name
Apply sentence case to the sub-metric label:-* **Net Onchain Profit:** +* **Net onchain profit:**
59-62: Sentence-case sub-metric name
Apply sentence case to the sub-metric label:-* **Chain Revenue:** +* **Chain revenue:**
65-65: Sentence-case sub-metric name
Apply sentence case to the fee label:-* **L1 Gas Fees:** +* **L1 gas fees:**
76-80: Fix indentation and italic formatting for footnote
Indent the italic footnote under the bullet and add a space after the asterisk:-* *Each chain's `SystemConfigProxy` contract can be found in the [Superchain Registry](/superchain/superchain-registry)* +* * Each chain's `SystemConfigProxy` contract can be found in the [Superchain Registry](/superchain/superchain-registry)*
105-105: Apply sentence-case to H4 header
Update to only capitalize the first word (and proper nouns):-#### Measuring growth: Net TVL Flows +#### Measuring growth: net TVL flows
125-125: Consider avoiding ampersand in H2 header
For clarity and accessibility, you might replace&withand:-## Network usage & infrastructure +## Network usage and infrastructure
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(2 hunks)words.txt(0 hunks)
💤 Files with no reviewable changes (1)
- words.txt
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[duplication] ~72-~72: Possible typo: you repeated a word.
Context: ... * from address = batcherHash address * to address = batchInbox address * Both are...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (32)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (32)
4-4: Frontmatter completeness verified
The frontmatter includes all required fields (title, lang, description, topic, personas, categories, content_type).
15-16: Import of Callout component is appropriate
TheCalloutimport fromnextra/componentssupports the info block later.
19-19: Introductory paragraph is clear
The updated intro succinctly explains document scope and structure.
21-21: H2 header follows sentence-case
"Measuring demand" correctly capitalizes only the first word.
29-33: REV calculation block is clear
The "Calculation:" bold heading and code snippet accurately convey the formula.
37-37: "Why it matters" heading is consistent
The bold "Why it matters:" fits the style used elsewhere.
44-44: Definition heading is consistent
The bold "Definition:" for collective revenue aligns with other metrics.
46-46: Calculation heading is consistent
The bold "Calculation:" is properly formatted.
49-51: Collective revenue formula is clear
The code block accurately represents themax(2.5% × Chain Revenue, 15% × Net Onchain Profit)formula.
71-74: Transaction batches classification is clear
The nested list and description properly document the criteria.🧰 Tools
🪛 LanguageTool
[duplication] ~72-~72: Possible typo: you repeated a word.
Context: ... *fromaddress =batcherHashaddress *toaddress =batchInboxaddress * Both are...(ENGLISH_WORD_REPEAT_RULE)
91-91: TVL definition heading is consistent
The bold "Definition:" for TVL follows established pattern.
93-93: TVL calculation heading is consistent
The bold "Calculation:" aligns with other sections.
95-97: TVL formula code block is clear
TVL = Σ (USD value of assets locked)is correctly formatted.
98-100: Info Callout is properly used
The<Callout type="info">block provides necessary context on pricing.
102-102: "Why it matters" heading is consistent
The bold "Why it matters:" for TVL matches style.
107-107: Net TVL Flows description is clear
The prose effectively explains the adjustment for volatility.
109-113: Net TVL Flows calculation block is clear
The formula and code fence accurately illustrate the computation.
115-115: Example heading is consistent
Bold "Example:" aligns with pattern used for examples.
120-120: Analysis heading is consistent
Bold "Analysis:" follows the established style.
127-127: H3 header is sentence-case
"Computational demand" correctly uses only initial capitalization.
131-131: Context definition heading is consistent
Bold "Definition:" for computational demand is correct.
133-133: Context heading is consistent
Bold "Context:" clearly introduces supplementary details.
137-137: "Why it matters" heading is consistent
The bold "Why it matters:" fits the pattern.
139-139: Important Note styling is consistent
Bold "Important Note:" properly flags the cross-chain warning.
145-145: Median fee definition heading is consistent
Bold "Definition:" for median transaction fee aligns with other metrics.
147-147: Median fee calculation heading is consistent
Bold "Calculation:" is formatted correctly.
149-151: Median fee formula code block is clear
The code fence and formulaMedian Fee = median(All transaction fees over period)are correct.
153-153: Italic USD conversion note is clear
The note "Converted to USD at transaction time" provides necessary context.
162-162: H2 header "Market position" is sentence-case
This header correctly capitalizes only the first word.
164-164: H3 header "Market share" is sentence-case
The header follows sentence-case rules.
168-168: Market share calculation heading is consistent
Bold "Calculation:" aligns with other metric sections.
171-172: Market share formula code block is clear
The fenced code accurately shows the share computation.
Description
Cleaned up contents and calculations
Tests
Additional context
Metadata