Understanding Smart 404 Pages
The HelpDocs Trial
Logging In To Your HelpDocs
Setting Up a Custom Domain
Adding or Changing Your Profile Image
Understanding Top Articles
Switching Between Multiple Accounts
Setting the URL Style for your Articles
Writing and Editing Articles
Using Quote Blocks
Getting Started with Content Blocks
Embedding Audio Files
Adding a HTML Block
Using Markdown Blocks
Using Code Blocks
Text Editor Shortcuts
Article Backups, Revisions and Versioning
Adding Tags to Articles
Adding Info, Tip and Warning Callouts
Inserting Images into Ordered Lists
Understanding Article Statuses
Switching the Editor Mode
Using Ordered Lists
Moving an Article to a Different Category
Getting started with taxonomy
Adding a Table of Contents
Restoring Deleted Articles
Previewing Unpublished Articles
Downloading Articles to PDF
Creating a Subcategory
Linking to a Part of an Article
Collaborating on Articles with Presence
Featuring an Article
Hiding Articles from Public Search Engines
Bulk Select & Edit Multiple Articles
Exporting & Backing Up Your Articles
Understanding Search Results
What is Readability?
Incompatible Browser Extensions
How to Add Extra Spacing
Setting Up Integrations
Available Commands in Your Slack Workspace
Sharing Articles From HelpDocs to Slack
Installing the Slack Integration
Configuring your Slack Integration
Get Feedback, Activity, and Contact Form Notifications in Slack
Using HelpDocs with Ticketing Systems
Syncing Content to elevio
Enabling Comments with Disqus
Adding a Feedier Carrier
Connecting Google Analytics
Customizing your HelpDocs
Making Video Embeds Responsive
Using Different List Styles
Overriding the Font on Your Knowledge Base
Using a Background Image in the Header
Adding Lightboxes to Images
Disabling Related Articles
Using HelpDocs with RTL Languages
Making Tables Scroll When They're Too Wide for the Page
Getting Help with Code Snippets
Disabling Authorship and Updated Times
Making your printed HelpDocs look nicer
Disabling Top Articles
Custom HTML Templates
Choosing a Template
Uploading Your Brand Logo
Understanding the Contact Form
Adding Custom CSS
Adding Icons to Categories
Setting a Custom Favicon
Adding Custom Navigation Links
Setting Category Display Order
Setting Article Display Order
Featuring a Category
Adding URL Redirects
Hiding the Contact Button
Customizing an Article Slug, Meta Description & Short Version
Adding an Open Graph Fallback Image
Changing the Language in Common Phrases
Hosting HelpDocs at a Subfolder of Your Site
Setting Up Multilingual Docs
Automatically Translate Articles with Machine Translations
Translating Your Docs
Removing permission groups from articles
Creating and Managing Permission Groups
Getting Started with Permissioning
Assigning permission groups to articles
Restricting your HelpDocs with Custom JWT SSO
Restricting Your Docs to Logged In Users
Accessing User Data in HelpDocs
Shared Password Protection
Setting Up and Using SAML Single Sign-On
Using OpenID Connect for Single Sign On
Restricting Your Docs by IP
Configuring Slack Single Sign On
Data & Analytics
Search Click Analytics
Exporting Your Stats
What is the Happiness Score?
What are Tickets Avoided?
Getting Team Event History with Audit Trail
Updating Your Billing Information
European Union VAT Charges
Changing Your Plan
Cancelling Your Account
Subscribing to a Plan for the First Time
Invoices and Email Receipts
Can I embed files into HelpDocs?
How do I reset my password?
Help! My app's not loading 😭
Help! No articles are appearing on my knowledge base
I’m seeing a blank screen when I load my knowledge base
I can't log into my HelpDocs account
I've added a script but it isn't working
What is an account slug?
Can I host my API docs in HelpDocs?
Can I use multiple HelpDocs accounts together?
My article has a blank space to the left of it. What's wrong?
How do related articles work?
Can I change the HelpDocs branding?
Can I host my internal docs in HelpDocs?
Who counts towards the user limit on plans?
Is HelpDocs GDPR compliant?
How do I change my email?
Is my data secure and protected?
Can I migrate or import my data from another service?
Will translated articles be deleted if I remove that language?
Clearing the Cache in Your Browser
Creating a Knowledge Base from Scratch
Writing Clear and Digestible Knowledge Base Articles
Finding CSS Selectors in Your Browser
Optimizing Your Knowledge Base for Search
Table of Contents
Updated by Jarratt Isted
Whether you're an engineer marking outdated articles based on a product update or part of the customer support team reminding yourself to update some information, marking an article as stale can keep your product & articles in sync and visitors happy.
Mark as Stale
- Head to the outdated article
- In the article editor, click Set Stale
- Click Set immediately
- Your article is now marked as stale for your whole team to see
Mark Stale in the future
You might know an article will go stale at a certain time in the future, or you might just like to know when it's getting a little old and take a look to see if it's still relevant. You can set an article to go stale in the future. There are a few options for this:
- In 30 days
- In 6 months
- In a year
- Custom date
Adding a reason for Stale
If you have multiple team members editing articles, it's pretty useful to know why and article is set to Stale. By adding a reason, you can leave a hint about what needs to be updated for others to pick up.
- Head to your Stale article
- Within the message, click Add new reason
- Click Save Reason to update
Good question! Our Stale robot automatically adds this reason when Stale is activated.
Keeping an article as Stale on save
There may be a time when you're quickly updating part of an article but you know there is still outdated information within the content.
To prevent an article being marked as fresh when saved, toggle Remain Stale on Save and it'll stay Stale.
How to tell if an article has gone stale
You and your team will see a few pointers to an article having gone stale.
- The article will have a yellow background and stale badge in the Content table
- In the article editor, you'll see a message above the editor
Keep articles fresh with weekly stale emails
You can keep on top of stale articles by subscribing to stale email reports. In these reports, you'll get a quick summary of:
- How many stale articles are in your account
- Which articles are newly stale this week
Here's how to opt-in:
- Head to your profile (or click here)
- Toggle on Send me weekly Stale emails