---
metadata:
  - name: generator
    content: Diplodoc Platform v5.54.2
  - property: og:type
    content: article
  - property: article:section
    content: Plugin platform
  - property: og:title
    content: Publishing a plugin and its help
  - property: article:tag
    content: Technical instructions
alternate:
  - https://yandex.ru/support/tracker/en/plugins/publish.md
  - https://yandex.ru/support/tracker/ru/plugins/publish.md
  - href: en/plugins/publish.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/tracker/en/llms.txt


# Preparing a plugin for publishing

Tracker users can find and enable plugins in the catalog: [How to connect and use plugins](https://yandex.ru/support/tracker/en/user/plugin-catalog.md).

To add your developed plugin to the catalog:

1. Prepare the description and images for the plugin.

1. Prepare the help — documentation for users.

1. Submit the plugin for publishing.

1. Wait for it to pass moderation.

Once the plugin passes moderation, it will appear in the catalog of your organization with a request to enable. [How to approve a request](https://yandex.ru/support/tracker/en/plugins-admin.md#approve-request)

A plugin developed in your organization can also be added to the public catalog so that it becomes available to employees of other organizations. To do this, [contact Tracker support](https://yandex.ru/support/tracker/en/feedback.md).


## Designing the card {#card}

Before publishing, add images and a description for the plugin card to the project:

- `public/logo.svg` — plugin logo, must be square.
- `marketplace/header-image.jpg` — image for the plugin card, must have a 2.41:1 aspect ratio.
- `marketplace/index.md` — description for the plugin card.

### Name {#title}

- Use 3 to 32 characters.
- Write the name in English. Official brand and product names, such as Figma or Miro, are allowed as exceptions.
- Don't include words such as “plugin”, “widget”, or “app” in the name.
- Don't use only the name of the service that the plugin integrates with.
- Don't use a name that is more than 90% similar to the name of an existing plugin or app.
- Don't put a period at the end.

For an integration with an external service, use the “function + service” naming pattern. For example: _Sending messages to Telegram_.

### Short description {#synopsis}

The short description is displayed on the plugin card in the catalog. It should complement the name and explain the plugin's primary function.

- Write one or two sentences with a total length of up to 75 characters.
- Don't put a period at the end.

Example:

- Name: _Private notes_.
- Short description: _A private space for notes in an issue with flexible access permissions_.

### Full description {#full-description}

The full description must not exceed 4,000 characters. You can use bulleted and numbered lists. Don't add external links or advertising.

Recommended structure for the full description:

1. What problems the plugin solves. List its main features.
1. Who the plugin is intended for. Specify the roles or job titles of users who may find it useful.
1. How to use the plugin. Add a brief guide or usage scenario.

### Text style and tone {#text-style}

- Use a neutral, informative tone. Don't use promotional claims, superlatives, or unsubstantiated statements such as “best” or “No. 1”.
- Use letters, numbers, single spaces, and necessary punctuation marks. Don't add emoji, exclamation marks, or special characters such as `@`, `#`, `$`, `%`, `^`, `&`, or `*`.
- Don't use uppercase letters for emphasis. Acronyms of up to four letters, such as API or CRM, are allowed as exceptions.
- Don't capitalize common nouns.
- Don't abbreviate words.
- Spell brand and product names the same way as on their official websites and in their documentation.
- Use hyphens and dashes correctly. For example, _Charon — data export_ is correct, while _Charon - data export_ is incorrect.
- Use diacritics where required by English spelling, including in proper names.

## Plugin category {#category}

To make plugins easier to find, they're grouped by category in the catalog. When creating or publishing a plugin, you need to specify its categories. Categories are set in the [manifest](https://yandex.ru/support/tracker/en/plugins/common.md#manifest) in the `categories` field.

Full list of available categories:

#|
|| Slug | Name ||
|| `integrations` | Integrations ||
|| `analytics` | Analytics ||
|| `planning` | Planning ||
|| `development` | Development ||
|| `automations` | Automations ||
|| `productivity` | Productivity ||
|| `entertainment` | Entertainment ||
|| `ai-assistants` | AI assistants ||
|| `support` | Support ||
|| `security` | Security ||
|#

## Plugin help {#docs}

Help is your plugin's documentation for users. It's displayed in the plugin catalog and at the integration point in the Tracker interface.

There are two ways to provide help: host it on an external domain or include it directly in the plugin distribution package.

### External help {#external-docs}

If the documentation is already hosted on your domain, specify a link to it in the `docsUrl` field of `manifest.json`:

```json
{
    "docsUrl": "https://example.com/docs/plugin.html",
    "slots": {
        "tracker": {
            "issue.action": [
                {
                    "entrypoint": "index.html",
                    "contextLevel": "basic",
                    "title": {
                        "ru": "Мой плагин",
                        "en": "My Plugin"
                    }
                }
            ]
        }
    }
}
```

Tracker will display a link to the help in the plugin catalog and at your plugin's integration point.

### Internal help {#internal-docs}

If you want to include documentation directly in the plugin distribution package, create a `docs/` folder in the project root and place the `index.md` and `toc.yaml` files inside. The `toc.yaml` file describes the document structure:

```yaml
title: My Docs
href: index.md
items:
    - name: Introduction
      href: index.md
    - name: Getting Started
      href: getting-started.md
    - name: Reference
      href: reference.md
```

#### File structure {#file-structure}

Minimum structure for a single-page help:

```
docs/
├── toc.yaml
└── index.md
```

### Preview {#preview}

If you want to see what the documentation will look like, run the `build-docs` command and open `docs-build/index.html` in your browser.

### Publishing help {#publishing}

When [publishing the plugin](#publish), the help is automatically built with [Diplodoc](https://diplodoc.com/docs/ru/). After successful verification, the `/docs/index.html` link will be added to the plugin manifest.

{% note info %}

If the root help file is not named `index.md`, manually specify a link to it in the `docsUrl` field of the manifest. Replace `index.html` with the name of your file with the `.html` extension. For example: `"docsUrl": "/docs/my-guide.html"`.

{% endnote %}

The help is not embedded in the Tracker interface — the user follows the link, just like with external help.

## Publishing the plugin {#publish}

To submit a plugin for publishing:

1. Get a token for the CLI:

    ```bash
    weavix login
    ```

3. Run the publishing:

    ```bash
    weavix submit
    ```

    This command will automatically register the plugin if needed, upload the distribution package, and submit the version for moderation.

4. After submitting for moderation, check the publishing status:

    ```bash
    weavix list
    ```

## Adding to the catalog {#catalog}


After automatic moderation, the plugin will appear in your organization's catalog with a request to enable. The organization administrator will need to approve it. [How to approve a request](https://yandex.ru/support/tracker/en/plugins-admin.md#approve-request)

Once approved by the administrator, the plugin will become available to the organization's users just like plugins from the general catalog. [How to enable a plugin](https://yandex.ru/support/tracker/en/user/plugin-catalog.md)

To make a plugin created for your organization available to all Tracker users in the general catalog, contact the [support team](https://yandex.ru/support/tracker/en/feedback.md).