search

ethereum-optimism / docs

Optimism Developer Docs
https://docs.optimism.io
97 stars 185 forks source link

[DO NOT MERGE] Update brand assets #894

Closed jvmi7 closed 1 month ago

jvmi7 commented 2 months ago

[DO NOT MERGE] Updating the various brand assets on the docs site

netlify[bot] commented 2 months ago

Deploy Preview for docs-optimism ready!

Name Link
Latest commit 72a6d7e2592f2b9ff514e6b2388d13c25a1f00c5
Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/66eda349e54d1500080f323e
Deploy Preview https://deploy-preview-894--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.

coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in the pull request focus on updating the theme.config.tsx file, specifically the configuration object for the documentation theme. Key modifications include replacing the logo SVG structure, reformatting string quotations from double to single quotes across various properties, and making minor formatting adjustments in the toc section. The overall functionality of the theme configuration remains unchanged, with no alterations to exported or public entity declarations.

Changes

File Change Summary
theme.config.tsx Updated logo SVG structure; reformatted string quotations to single quotes; minor formatting changes in toc; no changes to functionality or exported entities.

Possibly related PRs

Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 10325b802543a4da63ccdb7c5e60d38bd7ba18b8 and 72a6d7e2592f2b9ff514e6b2388d13c25a1f00c5.
Files ignored due to path filters (3) * `public/img/icons/favicon.ico` is excluded by `!**/*.ico` * `public/logos/docs-header.png` is excluded by `!**/*.png` * `public/logos/twitter-logo.png` is excluded by `!**/*.png`
Files selected for processing (1) * theme.config.tsx (1 hunks)
Additional comments not posted (4)
theme.config.tsx (4)
`12-13`: **LGTM!** The updated logo SVG looks good. The simplified SVG structure improves readability and reduces complexity. --- `22-24`: **LGTM!** The `project` link and `docsRepositoryBase` URL are updated to use single quotes, which is a valid formatting preference. The URLs point to the correct GitHub repository. --- `26-40`: **LGTM!** The `footer` text update to single quotes is a valid formatting preference. The `toc` section retains its functionality, with minor formatting changes in the JSX structure. The `extraContent` function and the usage of the `FeelbackYesNo` component remain unchanged. --- `43-75`: **LGTM!** The `feedback` section's content and labels update to single quotes is a valid formatting preference. The `editLink` text update to single quotes is also a formatting preference and does not affect functionality. The `useNextSeoProps` function's logic remains unchanged, with string comparisons reformatted to single quotes. The `head` function retains its structure and functionality, with formatting updates to use single quotes for meta tags and link elements.
--- 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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- `I pushed a fix in commit , 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.