sanctuarycomputer / uniswap-docs

πŸ““ Uniswap V3 docs website redesigned
https://docs.uniswap.org
0 stars 0 forks source link

QA for home UI and markdown text #35

Closed nahbee10 closed 3 days ago

nahbee10 commented 3 days ago

Description

Type(s) of changes

Motivation for PR

How Has This Been Tested?

Tested on local and preview

Applicable screenshots

Follow-up PR

Summary by CodeRabbit

vercel[bot] commented 3 days ago

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
uniswap-docs-staging βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Nov 18, 2024 10:23pm
coderabbitai[bot] commented 3 days ago

Walkthrough

The changes in this pull request involve updates to the NewsletterForm component, the SentimentTracking component, and the custom.css stylesheet. In the NewsletterForm, the button's class attributes were modified for improved responsiveness. The SentimentTracking component received a margin adjustment. The CSS file updates include adding smooth scrolling behavior, padding adjustments for the .container class, and introducing a new .theme-doc-markdown class with nested styles for various HTML elements to enhance markdown text styling.

Changes

File Change Summary
src/components/NewsletterForm/index.tsx Updated button class attributes for responsive width and padding adjustments.
src/components/SentimentTracking/index.tsx Added margin-top utility class to outer <div> for spacing adjustments.
src/css/custom.css - Added smooth scrolling for .theme-doc-markdown class.
- Updated padding for .container class.
- Introduced .theme-doc-markdown class with nested styles for various elements.
src/pages/index.tsx Altered internal structure of ArticleLinkCard and updated divider elements for improved layout.
src/components/ThemeSwitch/index.tsx Set theme state to 'light' if no current theme is stored.

Assessment against linked issues

Objective Addressed Explanation
Markdown text styling (6) βœ…
- Headings βœ…
- Paragraph style βœ…
- Inline code βœ…
- Block quote βœ…

Possibly related PRs

Suggested reviewers

Poem

In a world of forms and styles so bright,
A button now stretches, a marvelous sight!
With markdowns dancing, in flex they align,
Our CSS sings, everything's looking fine!
So hop along, let’s celebrate this cheer,
For every change brings us closer, my dear! πŸ‡βœ¨


πŸͺ§ 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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 3 days ago

⚑️ Lighthouse Report

Mobile (view report)

Category Score
🟠 Performance 70
🟒 Accessibility 96
🟠 Best practices 83
🟠 SEO 85

Desktop (view report)

Category Score
🟒 Performance 99
🟒 Accessibility 96
🟠 Best practices 83
🟠 SEO 82

Lighthouse ran on https://uniswap-docs-staging-c8k16eprp-uniswap.vercel.app

github-actions[bot] commented 3 days ago

⚑️ Lighthouse Report

Mobile (view report)

Category Score
🟠 Performance 81
🟒 Accessibility 96
🟠 Best practices 83
🟠 SEO 85

Desktop (view report)

Category Score
🟒 Performance 97
🟒 Accessibility 96
🟠 Best practices 83
🟠 SEO 82

Lighthouse ran on https://uniswap-docs-staging-d8h76cp2k-uniswap.vercel.app

github-actions[bot] commented 3 days ago

⚑️ Lighthouse Report

Mobile (view report)

Category Score
🟠 Performance 86
🟒 Accessibility 96
🟠 Best practices 83
🟠 SEO 85

Desktop (view report)

Category Score
🟒 Performance 98
🟒 Accessibility 96
🟒 Best practices 92
🟠 SEO 82

Lighthouse ran on https://uniswap-docs-staging-rljkpe849-uniswap.vercel.app

github-actions[bot] commented 3 days ago

⚑️ Lighthouse Report

Mobile (view report)

Category Score
🟠 Performance 56
🟒 Accessibility 96
🟒 Best practices 92
🟠 SEO 85

Desktop (view report)

Category Score
🟒 Performance 98
🟒 Accessibility 96
🟒 Best practices 92
🟠 SEO 82

Lighthouse ran on https://uniswap-docs-staging-15cheipo5-uniswap.vercel.app