Docs are sites with multiple purposes like self-service, documentation, blogs, or FAQ. You can decide if the site is public or for internal use.
You can create various types of sites. Each site has settings, visibility, and content. For example, we use one site as HelpCenter for customers and another as a blog to update our followers. A third site we use for our internal documentation.
Go to the main menu on the left side and select Docs. The first time you get asked to create a site. Enter a type (Help Center, Blog, Documentation) and the name. If you want to create more sites, click on the New Site button at the bottom of the Docs menu.
Categories and Articles
The first step is to create categories. Then add articles. Writing an article is similar to typing a message. Additionally, you can add tables or embed videos. The article saves automatically.
You publish and unpublish an article by clicking on the toggle button Publish. In the article list, there is a small dot in front of each title. It describes the publish status
Green = is published
Yellow = is published, but the article contains unpublished changes
Grey = not published
When you hover over a category or article in the list, a button with three dots appears on the right. Click on it to find actions like Copy Article Link or Delete. At the very bottom of the list, there is the button sort mode. Click it to activate. This allows you to move categories and articles within the site.
In settings, you have options to change the name and visibility of the site. Each site has its own domain: your-product.helpspace-docs.io. Later, we will add a feature allowing you to create a custom domain.
The style of the site is essential, especially once the site is public to your customers. You have several styling options, such as adding a logo and choosing different colors.
You can also decide to hide or show information such as article ratings or the creator of the article.