Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

State of wallet report #174

Merged
merged 14 commits into from
Oct 4, 2024
Merged

State of wallet report #174

merged 14 commits into from
Oct 4, 2024

Conversation

odysseus0
Copy link
Collaborator

@odysseus0 odysseus0 commented Oct 2, 2024

Implement and Improve "State of Wallets 2024" Report

This PR implements the "State of Wallets 2024" report, originally drafted in Notion, into our Docusaurus system. It includes significant improvements to formatting, component usage, and overall presentation to match the original Notion document as closely as possible within the constraints of our documentation platform.

Key Changes and Improvements

Content Implementation

  • Added the full "State of Wallets 2024" report content (eeab060)
  • Fixed image links and improved formatting for better readability (33b0c80)
  • Merged the final edits from Reid (a5d9eb0)

Image Handling

  • Removed spaces from image filenames to prevent path reference issues (cd16bf8)
  • Fixed image path references (a68e9cf)
  • Added missing wallet logos, including Ambire wallet (7d51b11)
  • Added light/dark background to logo grid for better PNG visibility in different modes (5842260)

New Components and Styling

  • Implemented Figure component for images with captions
  • Added LogoGrid component to display wallet logos effectively
  • Updated custom styles to improve heading hierarchy and overall layout
  • Fixed figure caption text color for light and dark modes by using the INFIMA variable in the global CSS to ensure it matches the main text color (b91a07b)

Document Structure and Formatting

  • Restructured headings and improved overall formatting
  • Fixed misplaced headings for better document flow (6e22611)

Dependency Management

  • Fixed react-loadable dependency in yarn.lock
  • Removed package-lock.json as the project uses yarn for build (1aacfe3)

File Management

  • Renamed files to lowercase to avoid case sensitivity issues between local and build environments (b968a06)

Technical Details

  • Utilized MDX to embed React components within the Markdown content
  • Created custom React components (Figure, LogoGrid) to match Notion's layout capabilities
  • Implemented responsive design considerations for various screen sizes
  • Ensured proper rendering in both light and dark modes

Testing and Verification

  • Verified all images display correctly with appropriate captions
  • Checked responsiveness across different device sizes
  • Ensured consistent styling between light and dark modes
  • Validated proper rendering of custom components within the MDX content

Next Steps

  • Conduct a thorough review of the content for any remaining formatting issues
  • Consider gathering feedback on the new layout and components for potential further improvements
  • Update any related documentation or style guides to reflect new component usage

Copy link

vercel bot commented Oct 2, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flashbots-writings-website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 4, 2024 1:55am

Ran a script to replace all spaces in image filenames with underscores to prevent issues when referencing image paths.
- Corrected image captions and paths for better clarity and consistency.
- Updated figure references to ensure proper display in the document.
- Improved overall formatting for enhanced readability.
- Add import statements for Figure and LogoGrid components
- Restructure headings and improve formatting
- Implement Figure component for images with captions
- Add LogoGrid component to display wallet logos
- Update custom styles for better heading hierarchy
- Fix react-loadable dependency in yarn.lock
- Implemented background colors to ensure PNG logos with white main body are displayed correctly in light mode.
Adjusted figure caption text color using INFIMA variable in global CSS to ensure it matches the main text color in both light and dark modes.
- Refactored the EIP-712 section to use a responsive grid layout for figures.
- Changed the structure from individual Figure components to a row/column format for better alignment and presentation.
@odysseus0 odysseus0 merged commit dec6859 into main Oct 4, 2024
3 checks passed
@odysseus0 odysseus0 deleted the state-of-wallet branch October 4, 2024 10:05
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.

1 participant