Docs

How to use Docs

Docs is a powerful tool designed to help you organize and structure your information efficiently. Think of it as a digital filing cabinet with a sophisticated organizational system.

At the core of Docs is a hierarchical structure of Spaces, Topics and Pages that allows you to categorize your content in a clear and logical manner. This structure consists of three primary components:

Docs structure.svg

  • Docs spaces: These are the top-level containers for your documents. You can think of them as virtual folders for grouping related content together.
  • Docs topics: Within a Docs Space, you can create Topics to further organize your content. Topics act as subcategories, allowing you to refine your document structure.
  • Docs pages: These are the individual documents that contain your actual content. They are the building blocks of your knowledge base.

By combining Spaces, Topics, and Pages, you can create a comprehensive and intuitive document hierarchy that suits your specific needs. This structure makes it easy to find, access, and manage your information.

In the following sections, we will delve deeper into each component and explore the features and functionalities available within the Docs module.

Searching in Docs

Searching in Docs is fairly straightforward. In main Docs page click on Search button or use the shortcut CTRL + K .

Docs-search-1.png

This will open Search popup window. In there just type a text you want to search for...

Docs-search-2.png

Searched results will appear instantly. No need to confirm your searched query.

Docs-search-3.png

Your inserted text is searched through the content of Pages or Space/Topic/Page names. In top right corner a filter can be used to see only results relevant to your search.

In case the search will return too many result we show you first 5 the most relevant. The rest can be viewed clicking the Show all button.


Filtering Docs

In Docs module some basic filtering options are possible.

Filtering Docs Spaces

Docs-filter-1.png

Docs Space filter options:

  • Active only : Shows all active items (Active = live documents that haven't been deleted). This is default option.
  • Owned by me : Shows only spaces where you are assigned as Owner.
  • Favourite only : Shows only spaces that you marked as favourite.
  • Deleted only : Shows spaces that have been previously deleted.

Filtering Docs Topics & Pages

Docs-filter-2.png

Docs Topic & Page filter options:

  • Active only : Shows all active items (Active = live documents that haven't been deleted). This is default option.
  • Favourite only : Shows only items that you marked as favourite
  • Show with deleted : Shows mix of items together (Active + Deleted).

Work with favourites

For smoother work with frequently used instances you have an option to mark a space or page as favourite. This helps to use Docs more efficiently and save time when looking for needed documents.

Favourite2.svg

To mark a space or page as favourite simply click on Star icon for each instance you want to mark as favourite. To remove this instance from your favourite list click on the Star again.

Favourite instances are saved for each user separately

On top of that there is an option to show favourite items sorted always on top so you won't miss them. This option is ON by default however can be disabled.

Docs-sort.png