Catalog Grouping

To make catalogs easier to work with, you can group them on the home page by topic or department.

  • Catalog grouping is configured in the workspace.yaml file.

  • Settings from workspace.yaml are visible only to a specific user on a specific device. However, you can share them with teammates or publish them to the documentation portal.

  • By default, all spaces use the "Folders" grouping.

  • Users can configure their own grouping by adding frequently used catalogs to the "Favorites" group. It is displayed above all other sections and groups.

Grouping Types

  • Folder — a folder is displayed on the home page. Inside a folder, there can be directories and other folders.

  • Section — the section name and its attachments are displayed on the home page. Inside a section, there can be directories and other folders.

Configure Grouping

The catalog grouping type is set in workspace.yaml for each group separately:

  • view: section — sections. A section can only exist at the first level.

  • view: folder — folders. Folders can be nested inside one another and inside sections without restrictions.

For each section, specify the section code, title, and catalogs included in it. Example configuration:

name: Demo # Space name
icon: tag # Space icon
sections:
  products: # Section code 1, shown in the URL when navigating sections
    title: Products # Section title
    view: section # Catalog grouping display type (section). Section works only for top-level groups
    catalogs: # Catalogs in the section
      - ad # Repository name
      - ac # Repository name
    sections: # Folder inside the section
      security: # Folder code, shown in the URL when navigating folders
        title: Information Security # Folder title
        view: folder # Catalog grouping display type (folder)
        icon: shield # Folder icon
        catalogs: # Catalogs inside the folder
          - adr # Repository name
          - ap # Repository name
  company: # Section code 2
    title: Internal Information
  projects: # Section code 3
    title: Projects