Skip to content

Front-end UI/UX Improvements for Docs #465

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

Open
wants to merge 24 commits into
base: main
Choose a base branch
from
Open

Front-end UI/UX Improvements for Docs #465

wants to merge 24 commits into from

Conversation

MagicLex
Copy link
Collaborator

Front-end Improvements for Docs

This PR contains multiple UI/UX enhancements to improve the documentation site's readability, navigation, and overall user experience.

Key Changes

  • Refreshed landing page with cleaner layout and consistent styling
  • Added subtle background animation for visual interest
  • Improved navigation with fixed link paths (removing unnecessary /index/ suffixes)
  • Updated video section with more relevant and recent content
  • Added dark mode support with appropriate styling
  • Improved typography and spacing for better readability
  • Added zoomable images functionality for better viewing of diagrams
  • Updated the Slack invite link to a permanent URL
  • Streamlined hero section with better button layout
  • Improved code block styling and rendering

MagicLex and others added 23 commits February 6, 2025 11:47
…I dropdown fixes

- Redesigned index page with modern architecture diagram
- Reduced top margins across the site for better content visibility
- Created consistent width for content pages
- Added full_width page support
- Created CLAUDE.md with build instructions
- Attempted fixes for API dropdown menu z-index issues
- Fixed white magnifying glass icon in light theme search bar
- Fixed version dropdown to consistently show the correct version options
- Updated API dropdown and navigation to use correct URLs (linking to /latest instead of /dev)
- Enhanced homepage with modern hero section and improved visual hierarchy
- Fixed color inconsistencies and removed blue gradients from dark mode
- Improved navigation styling and color consistency throughout the site
- Added responsive design improvements for mobile devices
- Fixed z-index issues with overlapping elements

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
- Added ability to click on documentation images to see an enlarged version
- Implemented smooth image modal with transitions and loading indicators
- Added zoom icon indicators that appear on hover for better discoverability
- Ensured accessibility with keyboard navigation (Esc to close) and ARIA attributes
- Excluded small images, icons, and images in links from zoom functionality

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
- Added dotted underline to all external links (not pointing to docs.hopsworks.ai)
- Applied styling to both navigation links and content links
- Added dark mode support for external link styling
- Removed background gradient from hero section

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
- Removed green header background for better visual hierarchy
- Improved spacing and layout in landing page sections
- Enhanced code block styling for better readability
- Added subtle shadows for visual depth
- Fixed layout issues with content cards
- Made button styling more consistent
- Added breathing room to sections for better rhythm

This is a draft version for review, not final.

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
- Added geometric unicode symbols as icons for component sections
- Improved alignment and sizing of icons for better visual hierarchy
- Prepared placeholder spaces for deployment and community icons
- Refined CSS for consistent spacing and component styling

🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
- Removed green underlines for cleaner appearance
- Added consistent section headers and spacing
- Reorganized content for better visual hierarchy
- Standardized typography and button styling
- Improved cards layout with consistent margins
- Added cloud provider logos for deployment options
- Added section headers to improve navigation
- Created responsive community resources section

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Updated robots.txt for proper search indexing
- Adjusted CSS styling for more consistent layout
- Improved content styling and typography
- Reduced code redundancy in dropdown.js
- Fixed playlist column height in marctech.css
- Enhanced site description in mkdocs.yml
- Added maintenance note to README.md

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
…imation

- Standardize spacing, margins, and padding throughout the page
- Fix inconsistencies in layout, text alignment, and sizing
- Add lightweight background node animation to the hero section
- Make video playable directly within the page via embed
- Improve responsive layout and full-width containers
- Clean up formatting and visual hierarchy

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Add strict path checking to ensure animation only runs on homepage
- Add additional safeguard to verify hero section exists
- Improve logging for debugging

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Change nodes from circles to squares
- Add subtle rotation effect to the squares
- Maintain existing connection lines between nodes

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
…tion

- Fix relative links in navigation to remove /index/ suffix
- Update video section with more relevant content and better descriptions
- Improve video section header text
- Update Slack invite link with permanent URL

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
@MagicLex MagicLex requested a review from SirOibaf April 16, 2025 12:41
@rcnnnghm rcnnnghm self-requested a review April 24, 2025 07:21
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