Skip to content

Commit 9d0df2f

Browse files
AmmarAbouZorDmitryAstafyev
authored andcommitted
Docs: Overview for Plugins in Chipmunk UI.
Provide a document about the plugins integrations with Chipmunk UI including the plugin manager functionalities and selecting a parser plugin to use within a session + Visual overview for both of them.
1 parent 2740efe commit 9d0df2f

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

docs/assets/plugins/parser.gif

655 KB
Loading

docs/plugins/integration-ui.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Plugins Integrations in Chipmunk UI
2+
3+
This guide explains how to manage and use plugins directly within the Chipmunk application's user interface. For details on developing plugins or manually integrating plugin files, please refer to the [Plugins Development Guide](./development-guide.md).
4+
5+
## Plugins Manager
6+
7+
The Plugins Manager view shows all your integrated plugins, their status, logs, and associated README files.
8+
From here, you can add new plugins by selecting their directory, eliminating the need for manual file copying.
9+
The Plugins Manager also lets you remove plugins from the system, which permanently deletes their files from the Chipmunk home directory.
10+
11+
## Use a Parser Plugin
12+
13+
To use a parser plugin, first choose your data source (such as files, network streams, or process outputs). Then, select the desired parser from a dropdown list that includes all available parsers, both built-in and plugin-based.
14+
15+
## Visual Overview
16+
17+
Here is a small overview of the Plugins Manager and how to start a session using a parser plugin:
18+
19+
![Plugins in Chipmunk UI](../assets/plugins/parser.gif)

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ nav:
1313
- Chipmunk CLI Tool: cli.md
1414
- Plugins:
1515
- Development Guide: plugins/development-guide.md
16+
- Integration in Chipmunk UI: plugins/integration-ui.md
1617
- Plugins API Crate: plugins/plugins-api.md
1718
- Development:
1819
- Chipmunk Core:

0 commit comments

Comments
 (0)