From 6e45b2ab0f2fd72f3a62c79b5a7b46af24fd2f25 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 8 May 2026 04:23:32 +0000 Subject: [PATCH 1/2] =?UTF-8?q?=F0=9F=8E=A8=20Palette:=20Polishing=20the?= =?UTF-8?q?=20documentation=20and=20initialization=20experience?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 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. --- .Jules/palette.md | 5 +++++ Makefile | 22 +++++++++++----------- mkdocs.yml | 15 +++++++++++++++ test_file.txt | 1 + 4 files changed, 32 insertions(+), 11 deletions(-) create mode 100644 .Jules/palette.md create mode 100644 test_file.txt diff --git a/.Jules/palette.md b/.Jules/palette.md new file mode 100644 index 0000000..a402522 --- /dev/null +++ b/.Jules/palette.md @@ -0,0 +1,5 @@ +# Palette's Journal + +## 2026-05-08 - [Enhancing Documentation Accessibility with Dark Mode] +**Learning:** Providing a dark mode toggle in documentation improves accessibility for users with light sensitivity and allows for a more comfortable reading experience in low-light environments. +**Action:** Always consider including a theme toggle in documentation sites to respect user preferences and improve readability. diff --git a/Makefile b/Makefile index 27718a0..1ec3e6a 100644 --- a/Makefile +++ b/Makefile @@ -14,17 +14,17 @@ help: # Show help .PHONY: project project: # Rename project (run once) @if [ -d project ]; then mv project ${SOURCE}; fi - @sed -i '' 's/^::: project\.app/::: ${SOURCE}\.app/' docs/reference/app.md - @sed -i '' 's/^repo_name: .*/repo_name: ${GITHUB}\/${NAME}/' mkdocs.yml - @sed -i '' 's/^repo_url: .*/repo_url: https:\/\/github.com\/${GITHUB}\/${NAME}/' mkdocs.yml - @sed -i '' 's/^source = \[.*\]/source = \["${SOURCE}"\]/' pyproject.toml - @sed -i '' 's/^app = "project\.app:main"/app = "${SOURCE}\.app:main"/' pyproject.toml - @sed -i '' 's/^name = ".*"/name = "${SOURCE}"/' pyproject.toml - @sed -i '' 's/^description = ".*"/description = "${DESCRIPTION}"/' pyproject.toml - @sed -i '' 's/^authors = \[.*\]/authors = \["${AUTHOR} <${EMAIL}>"\]/' pyproject.toml - @sed -i '' 's/^# .*/# ${DESCRIPTION}/' docs/README.md - @sed -i '' 's/@.*/@${GITHUB}/' .github/CODEOWNERS - @sed -i '' 's/^github: \[.*\]/github: \[${GITHUB}\]/' .github/FUNDING.yml + @perl -i -pe 's/^::: project\.app/::: ${SOURCE}\.app/' docs/reference/app.md + @perl -i -pe 's/^repo_name: .*/repo_name: ${GITHUB}\/${NAME}/' mkdocs.yml + @perl -i -pe 's/^repo_url: .*/repo_url: https:\/\/github.com\/${GITHUB}\/${NAME}/' mkdocs.yml + @perl -i -pe 's/^source = \[.*\]/source = \["${SOURCE}"\]/' pyproject.toml + @perl -i -pe 's/^app = "project\.app:main"/app = "${SOURCE}\.app:main"/' pyproject.toml + @perl -i -pe 's/^name = ".*"/name = "${SOURCE}"/' pyproject.toml + @perl -i -pe 's/^description = ".*"/description = "${DESCRIPTION}"/' pyproject.toml + @perl -i -pe 's/^authors = \[.*\]/authors = \["${AUTHOR} <${EMAIL}>"\]/' pyproject.toml + @perl -i -pe 's/^# .*/# ${DESCRIPTION}/' docs/README.md + @perl -i -pe 's/@.*/@${GITHUB}/' .github/CODEOWNERS + @perl -i -pe 's/^github: \[.*\]/github: \[${GITHUB}\]/' .github/FUNDING.yml uv: # Install uv pipx install -f uv diff --git a/mkdocs.yml b/mkdocs.yml index 107e63d..ba86a46 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,6 +6,20 @@ edit_uri: edit/main/docs/ theme: name: material + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/brightness-4 + name: Switch to light mode features: - announce.dismiss - content.action.edit @@ -18,6 +32,7 @@ theme: - navigation.sections - navigation.tabs - navigation.tabs.sticky + - navigation.tracking - navigation.top - search.highlight - search.suggest diff --git a/test_file.txt b/test_file.txt new file mode 100644 index 0000000..5716ca5 --- /dev/null +++ b/test_file.txt @@ -0,0 +1 @@ +bar From da4f632610e5cec5d610f55fca50ddb011b24b96 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Fri, 8 May 2026 10:20:21 +0000 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=8E=A8=20Palette:=20Documentation=20U?= =?UTF-8?q?X=20improvements?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Added dark mode toggle and navigation tracking to documentation. - Removed temporary files and reverted Makefile changes per review feedback. --- .Jules/palette.md | 5 ----- Makefile | 22 +++++++++++----------- test_file.txt | 1 - 3 files changed, 11 insertions(+), 17 deletions(-) delete mode 100644 .Jules/palette.md delete mode 100644 test_file.txt diff --git a/.Jules/palette.md b/.Jules/palette.md deleted file mode 100644 index a402522..0000000 --- a/.Jules/palette.md +++ /dev/null @@ -1,5 +0,0 @@ -# Palette's Journal - -## 2026-05-08 - [Enhancing Documentation Accessibility with Dark Mode] -**Learning:** Providing a dark mode toggle in documentation improves accessibility for users with light sensitivity and allows for a more comfortable reading experience in low-light environments. -**Action:** Always consider including a theme toggle in documentation sites to respect user preferences and improve readability. diff --git a/Makefile b/Makefile index 1ec3e6a..27718a0 100644 --- a/Makefile +++ b/Makefile @@ -14,17 +14,17 @@ help: # Show help .PHONY: project project: # Rename project (run once) @if [ -d project ]; then mv project ${SOURCE}; fi - @perl -i -pe 's/^::: project\.app/::: ${SOURCE}\.app/' docs/reference/app.md - @perl -i -pe 's/^repo_name: .*/repo_name: ${GITHUB}\/${NAME}/' mkdocs.yml - @perl -i -pe 's/^repo_url: .*/repo_url: https:\/\/github.com\/${GITHUB}\/${NAME}/' mkdocs.yml - @perl -i -pe 's/^source = \[.*\]/source = \["${SOURCE}"\]/' pyproject.toml - @perl -i -pe 's/^app = "project\.app:main"/app = "${SOURCE}\.app:main"/' pyproject.toml - @perl -i -pe 's/^name = ".*"/name = "${SOURCE}"/' pyproject.toml - @perl -i -pe 's/^description = ".*"/description = "${DESCRIPTION}"/' pyproject.toml - @perl -i -pe 's/^authors = \[.*\]/authors = \["${AUTHOR} <${EMAIL}>"\]/' pyproject.toml - @perl -i -pe 's/^# .*/# ${DESCRIPTION}/' docs/README.md - @perl -i -pe 's/@.*/@${GITHUB}/' .github/CODEOWNERS - @perl -i -pe 's/^github: \[.*\]/github: \[${GITHUB}\]/' .github/FUNDING.yml + @sed -i '' 's/^::: project\.app/::: ${SOURCE}\.app/' docs/reference/app.md + @sed -i '' 's/^repo_name: .*/repo_name: ${GITHUB}\/${NAME}/' mkdocs.yml + @sed -i '' 's/^repo_url: .*/repo_url: https:\/\/github.com\/${GITHUB}\/${NAME}/' mkdocs.yml + @sed -i '' 's/^source = \[.*\]/source = \["${SOURCE}"\]/' pyproject.toml + @sed -i '' 's/^app = "project\.app:main"/app = "${SOURCE}\.app:main"/' pyproject.toml + @sed -i '' 's/^name = ".*"/name = "${SOURCE}"/' pyproject.toml + @sed -i '' 's/^description = ".*"/description = "${DESCRIPTION}"/' pyproject.toml + @sed -i '' 's/^authors = \[.*\]/authors = \["${AUTHOR} <${EMAIL}>"\]/' pyproject.toml + @sed -i '' 's/^# .*/# ${DESCRIPTION}/' docs/README.md + @sed -i '' 's/@.*/@${GITHUB}/' .github/CODEOWNERS + @sed -i '' 's/^github: \[.*\]/github: \[${GITHUB}\]/' .github/FUNDING.yml uv: # Install uv pipx install -f uv diff --git a/test_file.txt b/test_file.txt deleted file mode 100644 index 5716ca5..0000000 --- a/test_file.txt +++ /dev/null @@ -1 +0,0 @@ -bar