Configuration File

The .doc-root.yaml file stores the settings for the entire catalog. It is located in the documentation folder within the repository. An example of its content is:

code: GX             # Short name of the catalog
title: Gramax Docs   # Full name of the catalog
logo: ./logo.svg     # Logo
order: 2             # Position on the homepage relative to other catalogs
description: For documentation and knowledge storage. # Brief information about the catalog
style: black         # Color used for the catalog on the homepage
relatedLinks:        # Additional links available in the right panel
  - url: https://discord.gg/ERHdPsqT  # Link the button points to
    title: Discord Channel             # Label of the button
    icon: mail-question                # Icon name from Lucide.dev
versions:            # Catalog versions as glob patterns, e.g. v19.* or release-*
  - "v19.*"
  - "release-*"
properties:          # Catalog properties
  - name: version    # Property name
    type: Enum       # Property type
    style: blue      # Property style
    icon: icon       # Property icon
    values:          # Property values
       - "v19.*"
       - "release-*"
language: en         # Main catalog language
supportedLanguages:  # Supported catalog languages
   - en
   - ru