This article details the maximum limits related to knowledge base functionality, search, and themes in Guide. It also lists the allowable file types for themes.
Most of the limits in this article apply to functionality in Guide Professional and Enterprise or in Guide Enterprise only, with a few exceptions. The plan type is specified if it's not available in all plans.
Knowledge base limits
The following table shows the maximum limits related to knowledge base functionality in Guide.
| Item | Maximum |
|---|---|
| Total number of articles, excluding archived | 40,000 |
| Total number labels used for search on an article (Guide Professional and Enterprise) | 200 |
| Article attachment size | 20 MB |
| Total number of user segments (Guide Professional and Enterprise) | 200 |
| Total number of section levels (Guide Enterprise) | 5 |
| Total number of sections in a single section (Guide Enterprise) | 20 |
Search limits
The following table shows the maximum limits related to Help Center search.
| Item | Maximum |
|---|---|
| Native search queries | 300 characters or 50 terms |
| Instant search queries | 300 characters or 100 terms |
Theme limits (Guide Professional and Enterprise)
The following table shows the maximum limits for themes and assets in Guide.
| Item | Maximum |
|---|---|
| Total number of themes | 10 |
| Individual theme size | 30MB |
| Total theme assets size | 25MB |
| Individual theme asset size | 5MB |
| Individual theme asset name | 50 characters |
| Individual theme template size | 300KB |
| Total number of settings in manifest.json | 100 |
| Total number of options in a list type setting | 20 |
About migrated themes and limits
On November 14, 2017 we introduced a new theming experience in Guide. When you migrate from the previous theming experience, some new restrictions will be applied to your themes. During the migration process, we suspend some file type and file size limitations to allow you to move your theme and assets to the new theming experience where they will be easier to work with.
For example, if you have a number of PDFs or other files that are no longer supported in theme assets, you will be able to migrate your theme. From there you can export that theme to retrieve all of these files easily. However, you won’t be able to duplicate or re-import that theme until the unsupported files are removed from the theme.
Allowable file types for theme assets (Guide Professional and Enterprise)
The following table shows the file types that are allowed as theme assets. The allowable files types for assets are limited to the file types used in the theming of a Help Center.
| Asset type | File types allowed |
|---|---|
| Images | jpg, jpeg, png, gif, svg, webp, tiff, tif, bmp, ico, webm |
| Fonts | woff2, woff, eot, otf, ttf, svg |
| Text files | js, css, html, json, txt, xml |
| Other | mp4, swf, wav, ogg. mp3 |
Rich content files types, such as Microsoft PowerPoint, Microsoft Word and PDFs, can be article attachments but cannot be theme assets.
Why are there limits
- For security purposes it’s important to vet the types of files that customers are allowed to upload so that we don’t receive malicious files.
- To prevent misuse or abuse vectors, it's important to limit the total size of files.
- For performance reasons, it’s important to serve, save, import and export files quickly for customers.
For these reasons, we enforce the theme limitations described in this article in Guide.
3 Comments
For "Total number of section levels" = 5, is that true for Lite, Professional, and Enterprise, as this article's heading suggests? When I browse to the Arrange Articles page I see "Subsections for Enterprise: Use subsections to structure up to five levels of articles. That's deep."
Hi James -
Thanks for calling that out. Flexible Hierarchies, which is the functionality that allows you to create additional section levels (or s"sub-sections") is only available on Guide Enterprise, and does have the 5 level limit. We'll see if we can make that more clear in the way the article is written.
Sorry for the confusion James. I've updated the article to make it clearer which features are Professional and Enterprise or Enterprise only. Thanks for calling our attention to that!
Please sign in to leave a comment.