diff --git a/docs/contributing/style-guide.md b/docs/contributing/style-guide.md index 5682161dfc..415e92fdc6 100644 --- a/docs/contributing/style-guide.md +++ b/docs/contributing/style-guide.md @@ -724,7 +724,8 @@ You can use a link to a file embedding the entire file, or embed a range of code 1. Save your image to the `/static/img` folder. This folder structure mirrors the doc section folders. * When updating existing images (like if there's a Sumo UI change), do not add a new version; always replace existing images. Image files take up a lot of room and can slow build times. - * File format be .png or .gif. + * File format be PNG. Avoid using animated GIFs, as they're generally not accessible; instead, use static images, provide text descriptions, or ensure animations stop within 5 seconds. + * Max file size 2MB. 1. Add the import line to the top of your doc, underneath the [front matter header](#metadata-frontmatter), if it's not already there. ``` import useBaseUrl from '@docusaurus/useBaseUrl';