Frequently Asked Questions (FAQ)

What is %product%?

%product% is a managed service to collaboratively write, publish, review, analyse and collect feedback on personalised customer-facing docs the modern way. Our documentation portals consist of user guides and API references. You could also call %product% a documentation tool.

Is %product% a CMS?

Yes, %product% is a content management system (CMS) for documentation.

What is a documentation?

Documentation is an unlimited amount of pages that are correlated, grouped together and are shown on one index. For example, this support centre which you are currently viewing is only one documentation. See project structure for more information.

How can my users view my documentation pages?

They can navigate to your own documentation pages through a subdomain that you assign under %product% domain or through a subdomain under your own existing domain. Your docs can also be hosted on a path under your existing domain.

For example, that could be: pied-piper.developerhub.io or docs.your-company.com, or even your-company.com/docs. See the other hosting options here.

Can I use my own custom domain?

Yes. See Using Custom Domain.

Can I restrict who can view the documentation?

We provide many ways for making your docs site private, see all privacy options,

Can I restrict access to certain documentation/pages?

Our projects can either be public or private at a time. If you are restricting access internally to your teammates, then they can already access it through the editor. If you want to restrict access for readers who do not have %product% teammate access, then you would need a second project that is protected/private.

Is there support for draft versions?

Each version can be published or unpublished. Unpublished versions are the equivalent of draft versions.

How do the docs get hosted?

We handle all the hosting. Check out all hosting options here.

Is it mobile friendly?

Yes, all the published pages are optimised for mobile viewing. The editor has only been tested for use on desktop or iPad, however.

Can I change how it looks?

Every bit and piece can be changed. We provide many built-in options to make it easy for you to change logos, colours, navigation, font and layout. You can also provide your own Custom Landing Page, Custom CSS, Custom HEAD Tags and Custom Footer.

Would search engines index the pages?

If your project is public, then by default search engines will be able to index all the published pages. You can change this from the project settings.

Accented characters are not showing properly, what can I do?

That could happen because of our default font, change the project font to a font that supports your language.

Do you support DITA or DocBook?

There is no support for XML content models. %product% provides a modern experience with a WYSIWYG editor and advanced features for formatting, linking, data import/export and customisation.

Do you support Single-Sourcing?

Yes, we support content reuse and templates.

Do you support file uploads/attachments?

We have native support for images uploads. For videos, you may upload a video to YouTube and show it using a video block. Alternatively, you can embed a video from any other service using custom HTML block. For other file uploads, you would need to upload the file to a hosting provider (such as your own S3 bucket), and then you may add a link in your documentation page or even create a nice download button for it.

Can we sync the docs with a GIT repo?

It is not possible sync the docs with a git (github/gitlab) repo. The functionality that %product% provides is complex and dynamic. Features such as synced blocks, variables, comments, page linking and cloning among others would make maintaining all content in a git repo really hard, and users would need to read entire docs to know how to edit the content which would eventually cause broken documentation. That goes against what we're here to do: Making documentation easier for you.

You can always export the project if you needed a backup. You may also use our APIs to read and update pages programmatically.

Was this page helpful?