Data dashboard section #1650
Data dashboard section #1650
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA new documentation section for "Data and Dashboards" has been introduced under the app-developers area. This includes a main page that presents five cards linking to a data glossary, a Google Sheets dashboard, a Hex.tech dashboard, and two BigQuery datasets for onchain data. The documentation is supplemented by a new data glossary page defining and explaining key blockchain and Superchain metrics, including their calculations and significance. A metadata JSON file for the data glossary page has been added. Additionally, several new words related to DeFi and analytics have been appended to the project's word list. The main app-developers tools page was updated to include a new "Data and Dashboards" section with these resources. Sequence Diagram(s)sequenceDiagram
participant Developer as App Developer
participant Docs as Documentation Site
Developer->>Docs: Navigate to Data and Dashboards page
Docs-->>Developer: Display five cards (Data glossary, Google Sheets dashboard, Hex.tech dashboard, BigQuery Raw Data, BigQuery 4337 Data)
Developer->>Docs: Click on Data glossary card
Docs-->>Developer: Show Data Glossary page with metric definitions
Developer->>Docs: Click on any dashboard or data card
Docs-->>Developer: Redirect to external dashboard or BigQuery dataset
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: 3
🧹 Nitpick comments (2)
pages/app-developers/tools/data-and-dashboards.mdx (1)
22-24: Inconsistent indentation in card components.
Indentation for each<Card>should be uniform. Align the second card with the others:- <Card title="Superchain health dashboard" ... + <Card title="Superchain health dashboard" ...pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (1)
21-23: Inconsistent header casing.
Use sentence case for H2/H3 headers, capitalizing only the first word (proper nouns excepted):- ## Measure Demand + ## Measure demand - ### Transaction Fees Paid + ### Transaction fees paid
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
pages/app-developers/tools/data-and-dashboards.mdx(1 hunks)pages/app-developers/tools/data-and-dashboards/_meta.json(1 hunks)pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(1 hunks)words.txt(3 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.mdxpages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
words.txt
[duplication] ~97-~97: Možný preklep: zopakovali ste slovo
Context: ...ATADIR datadir Defi Defillama's devdocs Devnet devnet Devnets devnets devs direnv DISABLETXPO...
(WORD_REPEAT_RULE)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[style] ~17-~17: Consider replacing this word to strengthen your wording.
Context: ...ary This glossary is a living document and will be updated over time as new metric...
(AND_THAT)
🔇 Additional comments (5)
pages/app-developers/tools/data-and-dashboards/_meta.json (1)
1-3: JSON metadata mapping is correct.
The key"data-glossary"accurately maps to the page title"Data glossary".words.txt (2)
281-281: New term 'outperformance' is added appropriately.
Placement afteroutfileis alphabetically correct.
423-423: New term 'topline' is added in the correct order.
Placement betweentimeseriesandtriggerablealigns with list ordering.pages/app-developers/tools/data-and-dashboards.mdx (1)
1-13: Frontmatter fields are complete.
Required metadata (title,lang,description,topic,personas,categories,content_type) are present and valid.pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (1)
1-13: Frontmatter fields are complete.
All required metadata (title,lang,description,topic,personas,categories,content_type) are present and valid.
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: 1
♻️ Duplicate comments (2)
pages/app-developers/tools/data-and-dashboards.mdx (1)
17-17:⚠️ Potential issueIncorrect H1 header
The page heading is still# Bridging guides. Update to reflect this guide (# Data and dashboards).-# Bridging guides +# Data and dashboardspages/app-developers/tools/data-and-dashboards/data-glossary.mdx (1)
19-19:⚠️ Potential issueFix escaped link syntax
The link is escaped (\[#data-and-dashboards]) and won’t render. Use proper MDX link syntax.-Explore dashboards, analytics content, and other ways to engage with Superchain data \[#data-and-dashboards] +Explore dashboards, analytics content, and other ways to engage with Superchain data [Data and dashboards](/app-developers/tools/data-and-dashboards)
🧹 Nitpick comments (2)
pages/app-developers/tools/data-and-dashboards.mdx (2)
21-25: Avoid italic emphasis and enforce sentence case in bullets
Resource names shouldn’t be wrapped in italics and body copy should use sentence case. For example:-* *Superchain Health Dashboard*: High-Level metrics across the Superchain +* Superchain Health Dashboard: High-level metrics across the Superchain🧰 Tools
🪛 LanguageTool
[duplication] ~22-~22: Possible typo: you repeated a word.
Context: ...shboard*: High-Level metrics across the Superchain * Superchain Strategic Focus Dashboard: In-depth me...(ENGLISH_WORD_REPEAT_RULE)
29-29: Fix inconsistent indentation
One<Card>is over-indented by two spaces. Align all cards to the same indent (2 spaces).
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/app-developers/tools.mdx(1 hunks)pages/app-developers/tools/data-and-dashboards.mdx(1 hunks)pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(1 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.mdxpages/app-developers/tools/data-and-dashboards.mdxpages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards.mdx
[duplication] ~22-~22: Possible typo: you repeated a word.
Context: ...shboard*: High-Level metrics across the Superchain * Superchain Strategic Focus Dashboard: In-depth me...
(ENGLISH_WORD_REPEAT_RULE)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[style] ~17-~17: Consider replacing this word to strengthen your wording.
Context: ...ary This glossary is a living document and will be updated over time as new metric...
(AND_THAT)
⏰ 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 (2)
pages/app-developers/tools.mdx (2)
60-60: No comment needed on removed blank lines.Also applies to: 67-67
70-80: New cards section looks good
All card titles are in Title Case, links and icons are correct.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (2)
19-24: Section headers should use sentence case.
H2 and H3 headers currently use title case. Update them to sentence case (e.g.,## Measure demand,### Transaction fees paid,## Onchain signals,### User experience (UX),## Market share).Also applies to: 36-42, 58-62, 83-90, 93-99, 103-109
47-49: Fix Markdown formatting for key components.
The bullet for L1 Gas Fees uses incorrect italics and a stray backslash (*L1 Gas Fees:*\*). Replace with bold syntax for proper rendering:**L1 Gas Fees:**pages/app-developers/tools/data-and-dashboards.mdx (2)
17-17: H1 header should use sentence case.
Change# Data and Dashboardsto# Data and dashboards(capitalize only the first word) to comply with header style guidelines.
28-32: Consistent indentation for Card components.
Indent each<Card>tag uniformly under<Cards>(e.g., two spaces) to improve readability and maintain consistent formatting.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/app-developers/tools/data-and-dashboards.mdx(1 hunks)pages/app-developers/tools/data-and-dashboards/data-glossary.mdx(1 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.mdxpages/app-developers/tools/data-and-dashboards/data-glossary.mdx
🪛 LanguageTool
pages/app-developers/tools/data-and-dashboards.mdx
[duplication] ~22-~22: Possible typo: you repeated a word.
Context: ...shboard*: High-Level metrics across the Superchain * Superchain Strategic Focus Dashboard: In-depth me...
(ENGLISH_WORD_REPEAT_RULE)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx
[style] ~17-~17: Consider replacing this word to strengthen your wording.
Context: ...ary This glossary is a living document and will be updated over time as new metric...
(AND_THAT)
⏰ 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 (2)
pages/app-developers/tools/data-and-dashboards/data-glossary.mdx (1)
1-13: Frontmatter metadata is complete and valid.
All required fields (title, description, lang, content_type, topic, personas, categories) are present and non-empty as per guidelines.pages/app-developers/tools/data-and-dashboards.mdx (1)
1-13: Frontmatter metadata is complete and valid.
All required fields for a landing page (title, description, lang, topic) are present and non-empty.
No description provided.