Skip to content

Conversation

bradleycamacho
Copy link
Member

Sentence cases all meta.json files (nav files) in accordance with our style guide.

Reviewer, please take an extra moment to make sure I correctly capitalized the files. There were some instances where I had to make a judgement call :)

@bradleycamacho bradleycamacho requested a review from a team as a code owner October 23, 2024 22:19
Copy link

netlify bot commented Oct 23, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit ea7d614
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/671c087c186e610008587cdd
😎 Deploy Preview https://deploy-preview-1022--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

coderabbitai bot commented Oct 23, 2024

Walkthrough

This pull request includes extensive modifications to the casing of titles and string values across multiple JSON files within the project. The changes primarily involve converting titles from title case to sentence case to ensure consistency in formatting. No structural changes were made to the JSON objects, and the overall content remains intact.

Changes

File Path Change Summary
pages/_meta.json Titles updated to sentence case: "Getting Started" → "Getting started", "Superchain Faucet" → "Superchain faucet", "Gas Tracker" → "Gas tracker".
pages/builders/_meta.json Values updated to lowercase: "App Developers" → "App developers", "Chain Operators" → "Chain operators", etc.
pages/builders/app-developers/_meta.json Values updated to lowercase: "Superchain App Quick Start" → "Superchain app quick start", "Smart Contracts" → "Smart contracts", etc.
pages/builders/app-developers/bridging/_meta.json Values updated to lowercase: "Bridging" → "bridging", "Custom Token Bridges" → "Custom token bridges", etc.
pages/builders/app-developers/contracts/_meta.json Values updated to lowercase: "Compatibility" → "compatibility", "System Contracts" → "system-contracts", etc.
pages/builders/app-developers/tools/_meta.json Value updated: "Open Source Code Repo" → "Open source code repo".
pages/builders/app-developers/transactions/_meta.json Values updated to lowercase: "Transaction Fees" → "Transaction fees", "Estimating Fees" → "Estimating fees", etc.
pages/builders/app-developers/tutorials/_meta.json Titles modified to sentence case for consistency.
pages/builders/cex-wallet-developers/_meta.json Values updated to lowercase: "Guide for Exchanges" → "Guide for exchanges", "Guide for Wallets" → "Guide for wallets".
pages/builders/chain-operators/_meta.json Values updated to lowercase: "Start a Self-Hosted Chain" → "Start a self-hosted chain", etc.
pages/builders/chain-operators/configuration/_meta.json Values updated to lowercase: "Rollup Deployment Configuration" → "Rollup deployment configuration", etc.
pages/builders/chain-operators/deploy/_meta.json Values updated to lowercase: "Contract Deployment" → "Contract deployment", "Genesis Creation" → "Genesis creation".
pages/builders/chain-operators/features/_meta.json Values updated to lowercase: "Run an Alt-DA Mode Chain" → "Run an Alt-DA Mode chain", etc.
pages/builders/chain-operators/hacks/_meta.json Values updated to lowercase for consistency.
pages/builders/chain-operators/management/_meta.json Values updated to lowercase: "Using Blobs" → "Using blobs", "Snapshot Downloads" → "Snapshot downloads".
pages/builders/chain-operators/tools/_meta.json Values updated to lowercase: "Chain Monitoring" → "Chain monitoring", "Block Explorer" → "Block explorer".
pages/builders/chain-operators/tutorials/_meta.json Titles modified to sentence case for consistency.
pages/builders/node-operators/_meta.json Values updated to lowercase: "Run a Node in the Superchain" → "Run a node in the Superchain", etc.
pages/builders/node-operators/configuration/_meta.json Values updated to lowercase for consistency.
pages/builders/node-operators/management/_meta.json Values updated to lowercase: "Using Blobs" → "Using blobs", "Snapshot Downloads" → "Snapshot downloads".
pages/builders/node-operators/tutorials/_meta.json Values updated to lowercase: "Running a Node With Docker" → "Running a node with Docker", etc.
pages/builders/notices/_meta.json Values updated to lowercase: "Breaking" → "breaking", "Fault Proofs" → "fault proofs".
pages/builders/tools/_meta.json Values updated to lowercase: "OP Tools" → "OP tools", "Fee Calculator" → "Fee calculator".
pages/builders/tools/build/_meta.json Values updated to lowercase: "NFT Tools" → "NFT tools", "Block Explorers" → "Block explorers".
pages/builders/tools/connect/_meta.json Values updated to lowercase: "Networks and RPC Endpoints" → "Networks and RPC endpoints", etc.
pages/builders/tools/monitor/_meta.json Value updated: "Historical Data" → "Historical data".
pages/builders/tools/op-tools/_meta.json Titles updated to lowercase: "OP Mainnet Explorer" → "OP Mainnet explorer", etc.
pages/chain/_meta.json Values updated to lowercase and corrected a typo: "Getting Started: OP Mainnet" → "Getting started: OP Mainnet", etc.
pages/chain/identity/_meta.json Value updated: "About Attestations" → "About attestations".
pages/chain/security/_meta.json Values updated to lowercase: "Security Model & FAQ" → "Security model & FAQ", etc.
pages/chain/testing/_meta.json Values updated to lowercase: "Running a Local Development Environment" → "Running a local development environment", etc.
pages/connect/contribute/_meta.json Values updated to lowercase: "Contribute to Optimism Docs" → "Contribute to Optimism docs", etc.
pages/stack/_meta.json Values updated to lowercase: "Getting Started: OP Stack" → "Getting started: OP Stack", etc.
pages/stack/beta-features/_meta.json Value updated: "Custom Gas Token" → "Custom gas token".
pages/stack/fault-proofs/_meta.json Values updated to lowercase: "Fault Proofs Explainer" → "Fault proofs explainer", etc.
pages/stack/interop/_meta.json Values updated to lowercase: "Interop Explainer" → "Interop explainer", etc.
pages/stack/rollup/_meta.json Values updated to lowercase: "Rollup Overview" → "Rollup overview", etc.
pages/stack/security/_meta.json Value updated: "Pause and Unpause the Bridge" → "Pause and unpause the Bridge".
pages/stack/transactions/_meta.json Values updated to lowercase for consistency.

Possibly related issues

Possibly related PRs

Suggested reviewers

  • cpengilly

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4428558 and ea7d614.

📒 Files selected for processing (1)
  • pages/stack/transactions/_meta.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • pages/stack/transactions/_meta.json

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

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

@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.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between efb7da2 and 077cb88.

📒 Files selected for processing (39)
  • pages/_meta.json (2 hunks)
  • pages/builders/_meta.json (1 hunks)
  • pages/builders/app-developers/_meta.json (1 hunks)
  • pages/builders/app-developers/bridging/_meta.json (1 hunks)
  • pages/builders/app-developers/contracts/_meta.json (1 hunks)
  • pages/builders/app-developers/tools/_meta.json (1 hunks)
  • pages/builders/app-developers/transactions/_meta.json (1 hunks)
  • pages/builders/app-developers/tutorials/_meta.json (1 hunks)
  • pages/builders/cex-wallet-developers/_meta.json (1 hunks)
  • pages/builders/chain-operators/_meta.json (1 hunks)
  • pages/builders/chain-operators/configuration/_meta.json (1 hunks)
  • pages/builders/chain-operators/deploy/_meta.json (1 hunks)
  • pages/builders/chain-operators/features/_meta.json (1 hunks)
  • pages/builders/chain-operators/hacks/_meta.json (1 hunks)
  • pages/builders/chain-operators/management/_meta.json (1 hunks)
  • pages/builders/chain-operators/tools/_meta.json (1 hunks)
  • pages/builders/chain-operators/tutorials/_meta.json (1 hunks)
  • pages/builders/node-operators/_meta.json (1 hunks)
  • pages/builders/node-operators/configuration/_meta.json (1 hunks)
  • pages/builders/node-operators/management/_meta.json (1 hunks)
  • pages/builders/node-operators/tutorials/_meta.json (1 hunks)
  • pages/builders/notices/_meta.json (1 hunks)
  • pages/builders/tools/_meta.json (1 hunks)
  • pages/builders/tools/build/_meta.json (1 hunks)
  • pages/builders/tools/connect/_meta.json (1 hunks)
  • pages/builders/tools/monitor/_meta.json (1 hunks)
  • pages/builders/tools/op-tools/_meta.json (2 hunks)
  • pages/chain/_meta.json (1 hunks)
  • pages/chain/identity/_meta.json (1 hunks)
  • pages/chain/security/_meta.json (1 hunks)
  • pages/chain/testing/_meta.json (1 hunks)
  • pages/connect/contribute/_meta.json (1 hunks)
  • pages/stack/_meta.json (2 hunks)
  • pages/stack/beta-features/_meta.json (1 hunks)
  • pages/stack/fault-proofs/_meta.json (1 hunks)
  • pages/stack/interop/_meta.json (1 hunks)
  • pages/stack/rollup/_meta.json (1 hunks)
  • pages/stack/security/_meta.json (1 hunks)
  • pages/stack/transactions/_meta.json (1 hunks)
✅ Files skipped from review due to trivial changes (38)
  • pages/builders/_meta.json
  • pages/builders/app-developers/_meta.json
  • pages/builders/app-developers/bridging/_meta.json
  • pages/builders/app-developers/contracts/_meta.json
  • pages/builders/app-developers/tools/_meta.json
  • pages/builders/app-developers/transactions/_meta.json
  • pages/builders/app-developers/tutorials/_meta.json
  • pages/builders/cex-wallet-developers/_meta.json
  • pages/builders/chain-operators/_meta.json
  • pages/builders/chain-operators/configuration/_meta.json
  • pages/builders/chain-operators/deploy/_meta.json
  • pages/builders/chain-operators/features/_meta.json
  • pages/builders/chain-operators/hacks/_meta.json
  • pages/builders/chain-operators/management/_meta.json
  • pages/builders/chain-operators/tools/_meta.json
  • pages/builders/chain-operators/tutorials/_meta.json
  • pages/builders/node-operators/_meta.json
  • pages/builders/node-operators/configuration/_meta.json
  • pages/builders/node-operators/management/_meta.json
  • pages/builders/node-operators/tutorials/_meta.json
  • pages/builders/notices/_meta.json
  • pages/builders/tools/_meta.json
  • pages/builders/tools/build/_meta.json
  • pages/builders/tools/connect/_meta.json
  • pages/builders/tools/monitor/_meta.json
  • pages/builders/tools/op-tools/_meta.json
  • pages/chain/_meta.json
  • pages/chain/identity/_meta.json
  • pages/chain/security/_meta.json
  • pages/chain/testing/_meta.json
  • pages/connect/contribute/_meta.json
  • pages/stack/_meta.json
  • pages/stack/beta-features/_meta.json
  • pages/stack/fault-proofs/_meta.json
  • pages/stack/interop/_meta.json
  • pages/stack/rollup/_meta.json
  • pages/stack/security/_meta.json
  • pages/stack/transactions/_meta.json
🧰 Additional context used
🔇 Additional comments (2)
pages/_meta.json (2)

3-3: LGTM! Correct sentence case conversion.

The conversion from "Getting Started" to "Getting started" follows proper sentence case formatting.


47-47: LGTM! Correct sentence case conversion.

The conversion from "Gas Tracker" to "Gas tracker" follows proper sentence case formatting.

Copy link
Collaborator

@sbvegan sbvegan left a comment

Choose a reason for hiding this comment

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

a few small fixes, but once those are updated, you're free to merge

@sbvegan sbvegan merged commit be3ff1c into main Oct 25, 2024
7 of 8 checks passed
@sbvegan sbvegan deleted the meta-sentence-case branch October 25, 2024 21:56
@bradleycamacho
Copy link
Member Author

@sbvegan sorry totally missed your review, thanks for fixing those!

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