Skip to content

chore(docs): add visual examples to customization documentation #680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Fidesnoella merged 1 commit into from
Feb 19, 2026
Merged

chore(docs): add visual examples to customization documentation #680

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 36 additions & 1 deletion config/CUSTOMIZATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ Only options exposed in these namespaces are customizable. Core application logi
- **appName**: Name displayed throughout the application
- **browserTabTitle**: Text shown in the browser tab

![Application name](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/app-name.svg) ![Browser Tab title](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/browser-tab.svg)

*Figure 1: Application name and browser tab title*

### SEO Metadata

- **metaDescription**: Search engine description
Expand All @@ -49,6 +53,10 @@ Only options exposed in these namespaces are customizable. Core application logi
- **assets.favicon**: Browser favicon
- **assets.appIcon**: Application icon

![Main logo](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/logo.svg) ![Favicon](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/favicon.svg) ![Application logo](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/app-logo.svg)

*Figure 2: Logo and icon assets*

Assets can be placed in the frontend `public` directory or hosted externally.

### Theme colors
Expand All @@ -60,6 +68,10 @@ The following colors can be customized:
- Primary and secondary brand colors (including light, dark, and contrast text)
- Primary, secondary, and accent text colors

![Branding Colors](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/branding-colors.svg)

*Figure 3: Theme color application*

**Accessibility requirement:**

After updating colors, run Storybook locally with the chosen configuration and **run the accessibility tests** to ensure WCAG AA contrast compliance. Non-compliant color combinations will fail accessibility checks.
Expand All @@ -72,13 +84,21 @@ After updating colors, run Storybook locally with the chosen configuration and *

When disabled, all CV-related UI elements are hidden and CV APIs are not registered.

![Feature CV](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/feature-cv.svg)

*Figure 4: CV feature enabled*

### Authentication

- **auth.disableLoginCode**: Disable login code requirement
- **auth.disableRegistrationCode**: Disable registration code requirement

These settings control how users authenticate in the application.

![Login code enabled](https://raw.githubusercontent.com/tabiya-tech/docs/refs/heads/main/.gitbook/assets/login-code.svg) ![Registration code enabled](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/registration-code.svg)

*Figure 5: Login with code and registration with code enabled*

## Skills Report Configuration

The skills report supports branding, format, and content customization.
Expand All @@ -99,11 +119,16 @@ This allows single-brand or co-branded reports.
Partners can control which sections and fields appear in the report, including:

- Summary section
- Job title
- Experience title
- Company name
- Date range
- Location

![Skills Report customization](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/skills-report.svg)

*Figure 6: Skills report customization*


## Localization Configuration

Compass supports multiple languages through configuration.
Expand All @@ -118,6 +143,11 @@ Compass supports multiple languages through configuration.
- **i18n.conversation.default_locale**: Default conversation language
- **i18n.conversation.available_locales**: Locale-specific configuration, including date format

![Language Switcher](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/languages.svg)

*Figure 7: Language switcher interface*


For full translation setup, see the [Language Guide](../add-a-new-language.md).

## Sensitive Data Fields Configuration
Expand All @@ -132,6 +162,11 @@ This allows customization of:
- Validation rules and error messages
- Localized labels and values

![Sensitive Data Fields](https://raw.githubusercontent.com/tabiya-tech/docs/main/.gitbook/assets/sensitive-data-fields.svg)

*Figure 8: Sensitive data collection fields*


For the complete schema documentation and examples, see the [Sensitive Data Fields Configuration Guide](../frontend-new/sensitive-data-fields-config.md).

## Applying Configuration Locally
Expand Down