GH#77: docs: update site template screenshots - #120
Merged
Conversation
Contributor
Author
Completion Summary
aidevops.sh v3.20.5 plugin for OpenCode v1.15.12 with gpt-5.5 spent 9m and 137,797 tokens on this as a headless worker. |
📝 WalkthroughWalkthroughSite Templates documentation updated across two files to correct instructions, fix typos, and replace screenshots. Changes cover site template creation with descriptions, product assignment, checkout form template selection configuration, auto-replacement field matching, and placeholders editor access workflows. ChangesSite Templates Documentation Refresh
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/user-guide/configuration/site-templates.md (2)
24-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAlign screenshot alt text with the referenced image (lines 24–36)
- In
docs/user-guide/configuration/site-templates.md, lines 24, 28, and 36 all reference/img/config/site-templates-list.png, but the alt text describes different UI elements (“Sites list page”, “site type” modal dropdown, and “Copy Site” toggle). Update the alt text to match the single screenshot’s actual contents (or split into dedicated screenshots and references if they’re meant to be different).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/user-guide/configuration/site-templates.md` around lines 24 - 36, The three image alt texts "Add site button in the Sites list page", "Add site template modal with site type dropdown", and "Add site template modal with copy site toggle" do not match a single referenced screenshot; either update those alt text strings so they accurately describe the actual screenshot content, or replace the single shared image reference with separate screenshots and corresponding alt text entries for each UI element (Sites list, site-type modal dropdown, Copy Site toggle) wherever those three markdown image lines appear in the file.
124-136:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix screenshot reference mismatch in the auto search-and-replace example
- In
docs/user-guide/configuration/site-templates.md, both the “{{placeholder_name}}” step and the “Placeholders replaced with customer data” step use/img/config/site-templates-list.png, but there’s no separate “after replacement” screenshot available instatic/img/configto differentiate the two states; update the second image reference (or adjust the caption/alt text to match what the single image shows).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/user-guide/configuration/site-templates.md` around lines 124 - 136, The docs page uses the same screenshot (/img/config/site-templates-list.png) for both the placeholder example and the “after replacement” state; update the second occurrence (the image tag and its alt/caption) so it either points to the actual “after replacement” image (if available) or change the alt text/caption to indicate it’s the same screenshot shown earlier; look for the image markdown reference "/img/config/site-templates-list.png" and the neighboring captions in site-templates.md and replace or adjust the filename/alt text accordingly, ensuring consistency with the existing images "/img/config/checkout-form-template-step.png" and "/img/config/frontend-template-chooser.png".
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/user-guide/configuration/site-templates.md`:
- Around line 144-150: Update the navigation text in
docs/user-guide/configuration/site-templates.md and
docs/user-guide/configuration/auto-search-and-replace-in-site-templates.md to
use a consistent flow for reaching the placeholders editor—e.g., "Go to Ultimate
Multisite > Settings > Sites, scroll to the Site Template Options area, then
click Edit Placeholders in the sidebar" (referencing the "Edit Placeholders"
link and "Site Template Options" area to locate the instruction). Also replace
the duplicated image usage (/img/config/settings-sites-templates-section.png)
with the correct distinct screenshots or adjust the alt text to accurately
reflect that both references show the same screen; ensure each <img> uses a
unique asset and matching alt text so the two image references in
site-templates.md (and the two in auto-search-and-replace-in-site-templates.md)
accurately correspond to the UI step they depict.
---
Outside diff comments:
In `@docs/user-guide/configuration/site-templates.md`:
- Around line 24-36: The three image alt texts "Add site button in the Sites
list page", "Add site template modal with site type dropdown", and "Add site
template modal with copy site toggle" do not match a single referenced
screenshot; either update those alt text strings so they accurately describe the
actual screenshot content, or replace the single shared image reference with
separate screenshots and corresponding alt text entries for each UI element
(Sites list, site-type modal dropdown, Copy Site toggle) wherever those three
markdown image lines appear in the file.
- Around line 124-136: The docs page uses the same screenshot
(/img/config/site-templates-list.png) for both the placeholder example and the
“after replacement” state; update the second occurrence (the image tag and its
alt/caption) so it either points to the actual “after replacement” image (if
available) or change the alt text/caption to indicate it’s the same screenshot
shown earlier; look for the image markdown reference
"/img/config/site-templates-list.png" and the neighboring captions in
site-templates.md and replace or adjust the filename/alt text accordingly,
ensuring consistency with the existing images
"/img/config/checkout-form-template-step.png" and
"/img/config/frontend-template-chooser.png".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1410b0c6-21ac-4f97-8bac-74459b0cdff4
⛔ Files ignored due to path filters (5)
static/img/config/checkout-form-template-step.pngis excluded by!**/*.pngstatic/img/config/frontend-template-chooser.pngis excluded by!**/*.pngstatic/img/config/settings-sites-templates-section.pngis excluded by!**/*.pngstatic/img/config/site-template-edit-description.pngis excluded by!**/*.pngstatic/img/config/site-templates-list.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/user-guide/configuration/auto-search-and-replace-in-site-templates.mddocs/user-guide/configuration/site-templates.md
Comment on lines
144
to
+150
| You can have access to the template placeholders editor by heading to **Ultimate Multisite > Settings > Sites**, and then, on the sidebar, clicking the **Edit Placeholders** link. | ||
|
|
||
|  | ||
|  | ||
|
|
||
| That will take you to the placeholders' content editor, where you can add placeholders and their respective content. | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Description: Compare navigation instructions across both documentation files
echo "=== site-templates.md navigation ==="
rg -n -A2 -B2 'Edit Placeholders' docs/user-guide/configuration/site-templates.md
echo -e "\n=== auto-search-and-replace navigation ==="
rg -n -A2 -B2 'Edit Placeholders' docs/user-guide/configuration/auto-search-and-replace-in-site-templates.mdRepository: Ultimate-Multisite/docs
Length of output: 1184
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== site-templates.md (lines 140-155) ==="
nl -ba docs/user-guide/configuration/site-templates.md | sed -n '135,160p'
echo -e "\n=== auto-search-and-replace-in-site-templates.md (lines 15-40) ==="
nl -ba docs/user-guide/configuration/auto-search-and-replace-in-site-templates.md | sed -n '10,45p'Repository: Ultimate-Multisite/docs
Length of output: 170
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "=== site-templates.md (exact lines 140-155, incl. image markup) ==="
cat -n docs/user-guide/configuration/site-templates.md | sed -n '135,155p'
echo -e "\n=== auto-search-and-replace-in-site-templates.md (exact lines 18-40, incl. image markup) ==="
cat -n docs/user-guide/configuration/auto-search-and-replace-in-site-templates.md | sed -n '15,40p'Repository: Ultimate-Multisite/docs
Length of output: 2651
Fix inconsistent navigation wording and duplicated screenshot references in site templates docs.
- Navigation inconsistency:
docs/user-guide/configuration/site-templates.mdsays to click Edit Placeholders “on the sidebar” (line 144), whiledocs/user-guide/configuration/auto-search-and-replace-in-site-templates.mdsays to “scroll to the Site Template Options area” first (line 26). Align the flow across both pages. - Duplicate screenshot reference:
docs/user-guide/configuration/site-templates.mduses the same image file/img/config/settings-sites-templates-section.pngfor two different steps (lines 146 vs 150) but with different alt text, implying two different screens. The same duplicate file/path happens indocs/user-guide/configuration/auto-search-and-replace-in-site-templates.md(lines 28 vs 32). Use distinct screenshot assets (or update the references/alt text so they match the actual UI shown).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/user-guide/configuration/site-templates.md` around lines 144 - 150,
Update the navigation text in docs/user-guide/configuration/site-templates.md
and docs/user-guide/configuration/auto-search-and-replace-in-site-templates.md
to use a consistent flow for reaching the placeholders editor—e.g., "Go to
Ultimate Multisite > Settings > Sites, scroll to the Site Template Options area,
then click Edit Placeholders in the sidebar" (referencing the "Edit
Placeholders" link and "Site Template Options" area to locate the instruction).
Also replace the duplicated image usage
(/img/config/settings-sites-templates-section.png) with the correct distinct
screenshots or adjust the alt text to accurately reflect that both references
show the same screen; ensure each <img> uses a unique asset and matching alt
text so the two image references in site-templates.md (and the two in
auto-search-and-replace-in-site-templates.md) accurately correspond to the UI
step they depict.
superdav42
added
the
review-feedback-scanned
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updated site template docs to use dedicated template-selection, settings, description, and frontend chooser screenshots. Added the new screenshot assets under static/img/config and aligned the auto search-and-replace page with the Site Template Options screenshot. Ref #64.
Files Changed
docs/user-guide/configuration/auto-search-and-replace-in-site-templates.md,docs/user-guide/configuration/site-templates.md,static/img/config/checkout-form-template-step.png,static/img/config/frontend-template-chooser.png,static/img/config/settings-sites-templates-section.png,static/img/config/site-template-edit-description.png,static/img/config/site-templates-list.png
Runtime Testing
Resolves #77
aidevops.sh v3.20.5 plugin for OpenCode v1.15.12 with gpt-5.5 spent 9m and 137,797 tokens on this as a headless worker.
Summary by CodeRabbit