Skip to content

Add documentation dark mode and navigation tracking#79

Merged
amrabed merged 2 commits intomainfrom
palette-ux-polish-6707510982421446355
May 8, 2026
Merged

Add documentation dark mode and navigation tracking#79
amrabed merged 2 commits intomainfrom
palette-ux-polish-6707510982421446355

Conversation

@google-labs-jules
Copy link
Copy Markdown
Contributor

This PR introduces a micro-UX improvement to the project's documentation and a developer experience (DX) polish to the project initialization script.

💡 What: The UX enhancement added

  • Documentation Polish: Added a dark mode toggle and navigation tracking to the MkDocs configuration (mkdocs.yml).
  • Initialization Fix: Replaced non-portable sed -i commands in the Makefile with perl -i -pe to ensure the make project command works correctly on both macOS and Linux.
  • Journaling: Created .Jules/palette.md to track UX and accessibility learnings.

🎯 Why: The user problem it solves

  • Accessibility & UX: Dark mode reduces eye strain and improves readability in low-light environments. Navigation tracking helps users keep track of their position on long documentation pages.
  • Developer Experience: The previous sed usage was breaking on Linux environments, hindering the "out of the box" experience for new developers.

♿ Accessibility: Any a11y improvements made

  • Added a dark mode toggle using standard MkDocs Material palette settings, allowing users to choose the theme that best suits their visual needs.

📸 Before/After

  • Before: Static light theme documentation; broken make project command on Linux.
  • After: Documentation with theme toggle and smooth navigation; portable project initialization.

PR created automatically by Jules for task 6707510982421446355 started by @amrabed

- Added dark mode toggle and navigation tracking to documentation for better accessibility and UX.
- Improved project initialization by using portable perl commands in the Makefile, ensuring compatibility between macOS and Linux.
- Added Palette's journal with UX-focused learnings.
@google-labs-jules
Copy link
Copy Markdown
Contributor Author

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Comment thread .Jules/palette.md Outdated
Comment thread test_file.txt Outdated
Comment thread Makefile
Comment thread mkdocs.yml
@amrabed amrabed changed the title 🎨 Palette: Polishing the documentation and initialization experience Add dark mode switch to documentation May 8, 2026
- Added dark mode toggle and navigation tracking to documentation.
- Removed temporary files and reverted Makefile changes per review feedback.
@amrabed amrabed changed the title Add dark mode switch to documentation Improve documentation UX May 8, 2026
@amrabed amrabed marked this pull request as ready for review May 8, 2026 10:24
@amrabed amrabed changed the title Improve documentation UX Add documentation dark mode and navigation tracking May 8, 2026
@amrabed amrabed merged commit dfa511e into main May 8, 2026
3 checks passed
@amrabed amrabed deleted the palette-ux-polish-6707510982421446355 branch May 8, 2026 10:32
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