Recommended image size added

Dorset-Council-UK · Apr 11, 2024 · cc80c26 · cc80c26
1 parent a8f8874
commit cc80c26
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/db/versions.md b/docs/db/versions.md
@@ -36,7 +36,7 @@ The `Versions` table contains all the basic information about a version of GIFra
 - `ShowLogin` - A boolean indicating whether to show a login button on the version. If a user is already logged in, the account box will still always show, regardless of this setting
 - `VersionNotes` - An optional text area to record any notes about the version. These are only seen by admin and cannot be seen by users.
 - `FeaturedVersion` - A boolean indicating whether to show a version in the 'Featured versions' area on the versions home page. Leaving this unchecked will put the version with 'All versions' underneath.
-- `VersionImageURL` - An optional URL to an image that will show on a version's card on the version home page. If a URL is not supplied, a default image of the world will be used.
+- `VersionImageURL` - An optional URL to an image that will show on a version's card on the version home page. If a URL is not supplied, a default image of the world will be used. We recommend image sizes of 400px by 200px for a neat and consistent look.
 - `Hidden` - A boolean indicating whether to hide a version from the versions home page (this will not delete a version or stop it being accessed directly by its URL).
 
 ### VersionAnalytic

diff --git a/docs/gui/versions.md b/docs/gui/versions.md
@@ -22,7 +22,7 @@ Select **Create new version** and fill in the details:
 - Help URL (optional) - include a link to custom documentation
 - Feedback URL (optional) - include a link to a feedback form
 - Redirection URL (optional) - a URL to redirect the user to instead of loading the version. Can be useful if a version changes slug, or you want to point people elsewhere
-- Version image URL (optional) - include a URL to an image to use on the version home page. Leaving this blank will use a default image of the world instead
+- Version image URL (optional) - include a URL to an image to use on the version home page. Leaving this blank will use a default image of the world instead. We recommend image sizes of 400px by 200px for a neat and consistent look.
 - Purge cache - ticking this box will purge the cache and allow your version to be available for testing or use straight away
 
 On the right side of the screen, you'll see options for: