sanctuarycomputer / uniswap-docs

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

Guide page setup #31

Closed nahbee10 closed 3 days ago

nahbee10 commented 1 week ago

Description

Type(s) of changes

Motivation for PR

How Has This Been Tested?

Tested on local

Applicable screenshots

https://www.loom.com/share/a699a961c2c54c68bce79a43b0634ed2?sid=48a51aea-afee-4946-85e4-c3d708d253d0

Follow-up PR

Summary by CodeRabbit

Release Notes

vercel[bot] commented 1 week 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 15, 2024 5:05pm
coderabbitai[bot] commented 1 week ago

Walkthrough

The pull request introduces several changes across multiple files, primarily focusing on updating dependencies, enhancing CSS styles, and modifying React components. Key updates include the addition of new packages in package.json, the introduction of a PostCSS configuration file, and the enhancement of various CSS classes. React components such as DocBreadcrumbs, DocItemLayout, and SentimentTracking have been modified for improved functionality and structure. Additionally, new components like SentimentButton have been created to facilitate sentiment tracking.

Changes

File Change Summary
package.json Added dependencies: @headlessui/react, classnames, js-cookie, @types/js-cookie, postcss-import. Unchanged: typescript.
postcss.config.js New configuration file created with plugins: postcss-import, tailwindcss, autoprefixer.
src/css/custom.css Added new CSS classes and modified existing ones for layout and styling enhancements.
src/theme/DocBreadcrumbs.tsx Modified to render without props and removed SentimentTracking component.
src/theme/DocItem/Layout/index.js Introduced new component for document item layout with responsive TOC handling.
src/theme/DocItem/Layout/styles.module.css Adjusted CSS rules for consistent spacing and maximum width.
tailwind.config.js Updated content property to include docusaurus.config.js and modified spacing configuration.
src/components/Icons/index.tsx Added new icon components: Moon, Edit, Happy, Neutral, Sad and updated IconMap.
src/components/SentimentTracking/index.tsx Restructured layout and functionality, replacing external icons with local ones.
src/components/SentimentTracking/SentimentButton.tsx New component created for sentiment buttons with dynamic styling and event handling.
src/css/infima-overrides.css Added new rule for .navbar class to reset styles.
src/theme/Navbar.tsx Changed <nav> class name to "navbar" for consistency.
.eslintrc.json Adjusted ESLint rules for flexibility in prop-types, TypeScript enums, and variable usage.
.prettierignore Added ignore patterns for *.hbs and *.gif files.

Assessment against linked issues

Objective Addressed Explanation
Breadcrumbs βœ…
Side nav (on this page) βœ…
Edit this page button ❌ No implementation for an edit button present.
Prev/next on the bottom βœ… Pagination navigation styles and layout added.
Feedback module βœ… Sentiment tracking component serves this purpose.

Possibly related PRs

Suggested reviewers

Poem

In the garden where code does play,
New icons bloom, brightening the day.
With breadcrumbs to guide and styles anew,
A sentiment tracker, just for you!
So hop along, let’s celebrate this cheer,
For every change brings us closer, my dear! 🐰✨


πŸ“œ Recent review details **Configuration used: .coderabbit.yaml** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 0824f68649f98fb7b905c185d268ca75e869e2d1 and f0b5092e096166020e7b0f863b92ea6e366180d6.
πŸ“’ Files selected for processing (1) * `src/theme/DocItem/Layout/index.js` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * src/theme/DocItem/Layout/index.js

πŸͺ§ 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 1 week ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 1 week ago

⚑️ Lighthouse Report

Mobile (view report)

Category Score
🟠 Performance 54
🟒 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-ptwk2276o-uniswap.vercel.app

github-actions[bot] commented 1 week ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

Category Score
🟠 Performance 89
🟒 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-4hykpuf8b-uniswap.vercel.app

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 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 83
🟠 SEO 82

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 6 days ago

⚑️ Lighthouse Report

Mobile (view report)

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

Desktop (view report)

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

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

github-actions[bot] commented 3 days ago

⚑️ Lighthouse Report

Mobile (view report)

Category Score
🟠 Performance 71
🟒 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-8lp1wipy9-uniswap.vercel.app