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
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
030e4a5
Minor Update - On premise page content.
MagicLex Feb 6, 2025
684c20a
Significant Design Updates; Dark mode added. change of the css struct…
MagicLex Feb 28, 2025
c1a8377
Improve site styling, add modern architecture diagram, and attempt AP…
MagicLex Mar 4, 2025
d8cfdf4
UI and UX improvements across the documentation site
MagicLex Mar 4, 2025
9921ad8
Add zoomable images functionality
MagicLex Mar 4, 2025
ea47456
additional fixes
MagicLex Mar 4, 2025
125bf6b
Add dotted underline to external links
MagicLex Mar 4, 2025
845f7c6
Clean, consistent navigation styling
MagicLex Mar 4, 2025
4134208
[DRAFT] Improve landing page layout and code block styling
MagicLex Mar 4, 2025
d3729c8
Update landing page with flat unicode icons and improved styling
MagicLex Mar 4, 2025
38d80b8
minor fixes
MagicLex Mar 4, 2025
3820a08
small fix
MagicLex Mar 7, 2025
3b3c044
Improve landing page UI with cleaner layout and consistent styling
MagicLex Apr 15, 2025
9c0b314
Additional documentation improvements
MagicLex Apr 15, 2025
1836046
Remove side border, community resources section, and Github repo links
MagicLex Apr 15, 2025
d2f73c2
Replace startup license with serverless option in deployment section
MagicLex Apr 15, 2025
b951143
Update hero section with Serverless link and improve navigation wording
MagicLex Apr 15, 2025
458343e
Streamline hero section with clean button layout and Python installation
MagicLex Apr 15, 2025
b68ef29
Fix K8s installer layout while preserving proper code block rendering
MagicLex Apr 15, 2025
6c9d71e
Improve landing page with consistent spacing and subtle background an…
MagicLex Apr 15, 2025
30756d7
Fix background animation to only run on index page
MagicLex Apr 15, 2025
452f9e1
Update background animation with rotating squares
MagicLex Apr 15, 2025
3c3fe8d
Improve front page with better navigation links and updated video sec…
MagicLex Apr 16, 2025
ffa974c
Remove 'Home' label from navigation to use the default site title ins…
MagicLex Apr 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Hopsworks Documentation - Claude Guidance

## Build Commands
- Build and serve locally: `python -m mkdocs serve`
- Check links: `mkdocs serve & sleep 30 && linkchecker http://127.0.0.1:8000/ && kill $!`
- Install dependencies: `pip install -r requirements-docs.txt`

## Project Structure
- Documentation source in `/docs` directory
- Navigation defined in `mkdocs.yml`
- CSS customization in `/docs/css/`

## Style Guidelines
- Use Markdown for all documentation files
- Follow Material Design styling conventions
- Include descriptive alt text for all images
- Create concise, focused pages with clear headings
- Use admonitions for important notes/warnings
- Place new images in appropriate subdirectories under `/docs/assets/images/`
- Maintain consistent navigation structure in `mkdocs.yml`
- Use kebab-case for filenames (e.g., `feature-server.md`)
- Keep code examples concise and well-commented
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,9 @@ linkchecker http://127.0.0.1:8000/

# If ok just kill the server
kill -9 $SERVER_PID
```
```


## Maintenance
Always update the robot.txt to desintex previous versions of hopsworks documentation (located in doc/robots.txt)

Binary file modified docs/assets/images/hops-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/hopsworks-logo.png
Binary file not shown.
25 changes: 25 additions & 0 deletions docs/css/animation.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/**
* Styles for background animation
*/

.hero-section {
position: relative;
overflow: hidden;
}

.bg-animation-canvas {
position: absolute;
top: 0;
left: 50%;
transform: translateX(-50%);
width: 100vw; /* Use viewport width instead of percentage */
height: 100%;
z-index: 0;
pointer-events: none;
}

/* Ensure content sits above the animation */
.hero-content {
position: relative;
z-index: 1;
}
Loading