Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ jobs:
- name: Install Python dependencies
run: pip install -r requirements.txt

- name: Generate image slot references
- name: Generate image slot and gallery references
run: python scripts/generate_image_slots.py

- name: Generate site health report
Expand Down
36 changes: 36 additions & 0 deletions PROMPT_ACTION_LOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,39 @@ Verification
Open questions and follow-up

* Consider whether future template iterations should add dedicated README files for scientific working folders once those folders become part of the base template.

2026-04-23

Prompt

User asked: "Generate and integrate an image system for Working Group OASIS with semantic image slots, folder-driven process galleries, replacement guidance, and reusable site-wide integration."

Files and folders inspected

* docs/
* docs/assets/images/
* docs/stylesheets/
* scripts/
* mkdocs.yml
* README.md
* .github/workflows/

Actions taken

* Expanded the image build step to generate both stable slot references and reusable gallery includes from semantic folders.
* Added the missing `group-photo` slot and replaced the slot placeholder artwork with cleaner SVG placeholders matched to hero, button, and collaboration use cases.
* Added process-gallery folders, README instructions, starter placeholder assets, and sample linked deliverables.
* Wired slot images, figure-style replacement notes, and folder-driven galleries into the homepage, work plan, resources, and community care pages.
* Extended styling, site health checks, and GitHub Actions build steps to support the new image and gallery system.

Verification

* Ran `python3 scripts/generate_image_slots.py`.
* Ran `python3 scripts/site_health.py`.
* Ran `python3 scripts/check_template.py`.
* Ran `.venv/bin/mkdocs build --strict --clean`.
* Verified the rendered homepage and resources page in the in-app browser against the built `site/` output.

Open questions and follow-up

* If future template pages are added below another nested directory level, the gallery generator may need one more relative-path variant for those deeper pages.
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ Use these rules of thumb when deciding where to put something:
- `docs/resources.md` is where datasets, references, and code links can be collected.
- `docs/community-care.md` is where collaboration expectations and group care guidance live.
- `docs/assets/images/slots/` contains named image slots for the homepage and other shared visuals.
- `docs/assets/images/process/` contains folder-driven process galleries that render automatically on the site.

## Preview locally

Expand All @@ -57,15 +58,42 @@ mkdocs build --strict --clean

## Swapping homepage images

The homepage uses semantic image slots so Working Group members do not need to edit Markdown links every time an image changes.
The site uses semantic image slots so Working Group members do not need to edit Markdown links every time an image changes.

1. Open the relevant folder in `docs/assets/images/slots/`.
2. Delete the old image file.
3. Add one new `.png`, `.jpg`, `.jpeg`, `.webp`, or `.svg` file.
4. Run `python scripts/generate_image_slots.py`.
5. Commit the image change and the regenerated slot references.

If a slot folder contains multiple images, the generator prefers the first non-placeholder file alphabetically and the site health report will warn you to clean it up.
If a slot folder contains multiple images, the generator uses the first image alphabetically and the site health report will warn you to clean it up. The cleanest workflow is still one image per slot folder.

## Using process galleries

Process galleries are folder-driven. Add files to a gallery folder, commit them, and the site updates automatically.

1. Open the relevant folder in `docs/assets/images/process/`.
2. Add images or supported deliverable files.
3. Optionally add a `captions.txt` file with lines like `filename.png | Caption text`.
4. Run `python scripts/generate_image_slots.py`.
5. Commit the new files and the regenerated gallery includes.

Supported image files:

- `.png`
- `.jpg`
- `.jpeg`
- `.webp`
- `.svg`

Supported linked deliverable files:

- `.pdf`
- `.html`
- `.csv`
- `.xlsx`
- `.docx`
- `.pptx`

## Site Health

Expand Down
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/community/placeholder.svg">
<img src="../assets/images/process/community/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays community-facing updates, outreach visuals, and collaboration artifacts.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/community)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for event photos, outreach materials, collaboration snapshots, and community update graphics.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/data/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/data/placeholder.svg">
<img src="../assets/images/process/data/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays data source artifacts and metadata documentation for the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/data)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for dataset screenshots, metadata views, download notes, and data reference visuals.
>
> Delete this note after the site is finalized.
25 changes: 25 additions & 0 deletions docs/_generated/galleries/child/deliverables/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/deliverables/placeholder.svg">
<img src="../assets/images/process/deliverables/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

<div class="media-gallery media-gallery--files">
<a class="media-gallery__card media-gallery__card--file" href="../assets/images/process/deliverables/deliverable-checklist.csv">
<strong>Example deliverable checklist</strong>
<span>CSV file · deliverable-checklist.csv</span>
</a>
</div>

> This gallery displays deliverable files and linked products for the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/deliverables)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for reports, spreadsheets, slides, manuscripts, and other shareable deliverables.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/exploration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/exploration/placeholder.svg">
<img src="../assets/images/process/exploration/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays rough exploration artifacts for the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/exploration)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for draft plots, exploratory figures, and quick visual checks.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/methods/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/methods/placeholder.svg">
<img src="../assets/images/process/methods/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays methods, protocols, and analysis setup artifacts.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/methods)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for method diagrams, notebook screenshots, protocol sketches, and workflow setup visuals.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/outputs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/outputs/placeholder.svg">
<img src="../assets/images/process/outputs/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays emerging and final outputs from the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/outputs)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for draft figures, polished graphics, synthesis visuals, and final output previews.
>
> Delete this note after the site is finalized.
25 changes: 25 additions & 0 deletions docs/_generated/galleries/child/reports/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/reports/placeholder.svg">
<img src="../assets/images/process/reports/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

<div class="media-gallery media-gallery--files">
<a class="media-gallery__card media-gallery__card--file" href="../assets/images/process/reports/status-update.html">
<strong>Example HTML status update</strong>
<span>HTML file · status-update.html</span>
</a>
</div>

> This gallery displays report-ready documents and summary materials.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/reports)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for report drafts, PDFs, executive summaries, and update memos.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/start-here/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/start-here/placeholder.svg">
<img src="../assets/images/process/start-here/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays early setup artifacts for the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/start-here)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for kickoff notes, orientation screenshots, starter diagrams, and early planning visuals.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/whiteboards/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/whiteboards/placeholder.svg">
<img src="../assets/images/process/whiteboards/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays whiteboards, meeting sketches, and planning visuals.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/whiteboards)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for photographed whiteboards, conceptual sketches, and facilitation notes.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/child/workflows/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="../assets/images/process/workflows/placeholder.svg">
<img src="../assets/images/process/workflows/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays workflow artifacts and reproducibility notes.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/workflows)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for pipeline diagrams, task trackers, and reproducibility snapshots.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/root/community/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="assets/images/process/community/placeholder.svg">
<img src="assets/images/process/community/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays community-facing updates, outreach visuals, and collaboration artifacts.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/community)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for event photos, outreach materials, collaboration snapshots, and community update graphics.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/root/data/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="assets/images/process/data/placeholder.svg">
<img src="assets/images/process/data/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays data source artifacts and metadata documentation for the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/data)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for dataset screenshots, metadata views, download notes, and data reference visuals.
>
> Delete this note after the site is finalized.
25 changes: 25 additions & 0 deletions docs/_generated/galleries/root/deliverables/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="assets/images/process/deliverables/placeholder.svg">
<img src="assets/images/process/deliverables/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

<div class="media-gallery media-gallery--files">
<a class="media-gallery__card media-gallery__card--file" href="assets/images/process/deliverables/deliverable-checklist.csv">
<strong>Example deliverable checklist</strong>
<span>CSV file · deliverable-checklist.csv</span>
</a>
</div>

> This gallery displays deliverable files and linked products for the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/deliverables)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for reports, spreadsheets, slides, manuscripts, and other shareable deliverables.
>
> Delete this note after the site is finalized.
18 changes: 18 additions & 0 deletions docs/_generated/galleries/root/exploration/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- This file is generated by scripts/generate_image_slots.py. -->

<div class="media-gallery">
<figure class="media-gallery__card media-gallery__card--image">
<a href="assets/images/process/exploration/placeholder.svg">
<img src="assets/images/process/exploration/placeholder.svg" alt="Placeholder">
</a>
<figcaption>Placeholder</figcaption>
</figure>
</div>

> This gallery displays rough exploration artifacts for the working group.
>
> [Add or replace files in this gallery](https://github.com/CU-ESIIL/Working_group_OASIS/tree/main/docs/assets/images/process/exploration)
>
> To update: upload supported files to this folder and commit. The website sorts files alphabetically. Use this folder for draft plots, exploratory figures, and quick visual checks.
>
> Delete this note after the site is finalized.
Loading
Loading