Skip to content

GH#77: docs: update site template screenshots #120

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.

Sign up for GitHub

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

Merged
superdav42 merged 1 commit into from
May 30, 2026
Merged

GH#77: docs: update site template screenshots #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/user-guide/configuration/auto-search-and-replace-in-site-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ All of that is great, but we do run into an ugly problem: now our site templates

To solve that, we offer the option of setting fake values for the placeholders, and we use those values to search and replace their contents on the template sites while your customers are visiting.

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.
You can have access to the template placeholders editor by heading to **Ultimate Multisite > Settings > Sites**, scrolling to the Site Template Options area, and then clicking the **Edit Placeholders** link.

![Edit Placeholders link in the Sites settings sidebar](/img/config/settings-sites.png)
![Site Template Options area in the Sites settings page](/img/config/settings-sites-templates-section.png)

That will take you to the placeholders' content editor, where you can add placeholders and their respective content.

![Placeholders content editor with placeholder names and values](/img/config/settings-sites.png)
![Template placeholders editor entry point](/img/config/settings-sites-templates-section.png)
32 changes: 15 additions & 17 deletions docs/user-guide/configuration/site-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ This will open a modal window where it will ask for the **Site title, Site Domai

_![Add site template modal with site type dropdown](/img/config/site-templates-list.png)_

You can also view the site template description:
You can also add a customer-facing description to explain what the template includes:

![Site template description](/img/config/site-template-description.png)
![Site template description field on the site template edit screen](/img/config/site-template-edit-description.png)

At the bottom of the form, you will notice a **Copy Site** toggle switch. This will allow you to create a new site template based on an existing site template as your starting point to help you save time instead of creating a site template from scratch.

Expand Down Expand Up @@ -67,7 +67,7 @@ To do that, you’ll need to go to **Ultimate Multisite > Products > Edit**.

![Edit product to assign site template](/img/config/product-site-templates.png)

This will bring you to the **Edit Produc** t page. Under the **Product Options** section, find the **Site template** tab and select the **Assign Site** **Template** option from the drop-down field. This will bring up the list of site templates available and it will allow you to select only one site template dedicated to the product.
This will bring you to the **Edit Product** page. Under the **Product Options** section, find the **Site template** tab and select the **Assign Site Template** option from the drop-down field. This will bring up the list of site templates available and it will allow you to select only one site template dedicated to the product.

![Product site template tab with assign site template option](/img/config/product-site-templates.png)

Expand All @@ -81,23 +81,23 @@ On the **Edit Product** page. Under the **Product Options** section, find the **

### Default Mode: Site template selection on the Checkout form

If you wish all your site templates to be available during the registration, or maybe do not prefer doing extra work of assigning or specifying site templates under each product you create. Then you can simply set the site template selection under your **Checkout Form**. To do this, you just need to go to **Ultimate Multisite > Checkout Forms**. Then click **Edit** under the form you wish to configure.

![Checkout forms list page](/img/config/checkout-forms-list.png)
If you wish all your site templates to be available during the registration, or maybe do not prefer doing extra work of assigning or specifying site templates under each product you create. Then you can simply set the site template selection under your **Checkout Form**. To do this, go to **Ultimate Multisite > Checkout Forms** and click **Edit** under the form you wish to configure.

This will bring up the **Edit Checkout Form** page. Find the **Template Selection** field and click **Edit** under it.

![Checkout form editor with template selection field](/img/config/checkout-form-editor.png)

A modal window will appear. Under the **Template Sites** field you can select and list down all the site templates you wish to be available during registration. The site templates you specify from here will be available regardless of whatever product the user selected.

![Template sites field in checkout form editor](/img/config/checkout-form-step.png)
![Template selection field in the checkout form editor](/img/config/checkout-form-template-step.png)

On the frontend, customers see the template chooser during checkout and can pick the starting design for their new site.

![Frontend template chooser during registration](/img/config/frontend-template-chooser.png)

### Site Template Options

There are other site templates functions available that you can turn on or off under Ultimate Multisite settings.

![Site template options in Ultimate Multisite settings](/img/config/settings-sites.png)
![Site template options in Ultimate Multisite settings](/img/config/settings-sites-templates-section.png)

#### Allow Template Switching

Expand All @@ -123,15 +123,13 @@ For example, if you wish to get your end-user's company name during registration

![Homepage with placeholder text in curly braces](/img/config/site-templates-list.png)

Then, you can simply add a matching registration field on your checkout form to capture that data:
Then, you can simply add a matching registration field on your checkout form to capture that data. The same checkout form editor used for template selection lets you place custom fields alongside the template chooser:

![Checkout form with matching registration field](/img/config/checkout-form-editor.png)
![Template selection and registration fields in the checkout form editor](/img/config/checkout-form-template-step.png)

Your customer will then be able to fill that field during the registration.

![Registration field filled by customer](/img/config/checkout-form-step.png)

![Preview of the registration form](/img/config/checkout-form-editor.png)
![Frontend checkout form with template chooser](/img/config/frontend-template-chooser.png)

Ultimate Multisite will then replace the placeholders with the data provided by the customer automatically.

Expand All @@ -145,8 +143,8 @@ To solve that, we offer the option of setting fake values for the placeholders,

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.

![Placeholder settings under Sites settings page](/img/config/settings-sites.png)
![Site template settings under the Sites settings page](/img/config/settings-sites-templates-section.png)

That will take you to the placeholders' content editor, where you can add placeholders and their respective content.

![Template placeholders content editor](/img/config/settings-sites.png)
![Template placeholders content editor entry point](/img/config/settings-sites-templates-section.png)
Comment on lines 144 to +150

@coderabbitai coderabbitai Bot May 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 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.md

Repository: 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.

  1. Navigation inconsistency: docs/user-guide/configuration/site-templates.md says to click Edit Placeholders “on the sidebar” (line 144), while docs/user-guide/configuration/auto-search-and-replace-in-site-templates.md says to “scroll to the Site Template Options area” first (line 26). Align the flow across both pages.
  2. Duplicate screenshot reference: docs/user-guide/configuration/site-templates.md uses the same image file /img/config/settings-sites-templates-section.png for two different steps (lines 146 vs 150) but with different alt text, implying two different screens. The same duplicate file/path happens in docs/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.

Binary file added static/img/config/checkout-form-template-step.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/config/frontend-template-chooser.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/config/settings-sites-templates-section.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/config/site-template-edit-description.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/config/site-templates-list.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.