Add import and export documentation by sudeeptarlekar · Pull Request #2422 · esrlabs/chipmunk

sudeeptarlekar · 2025-10-02T13:03:32Z

Currently Chipmunk docs are missing information around importing and exporting functionality. This commit adds the page dedicated around import/export functionality in Chipmunk

Fixes #2417

AmmarAbouZor

Thanks for improving our documentations with assets 🙏
I've got multiple points to fix:

Your current assets use a DLT file which isn't open source. Those assets need to be removed because we don't even own the content of the used DLT file. Instead I would suggest using the logs of chipmunk app itself (Can be found in $HOME/.chipmunk/..) or the output of some long command (On linux I use journalctl command).
We already have a part for exporting and importing filters in our current docs. You can check that and improve the docs there if needed, but this part should be intended to export and import the logs only. (The title of the new file should include that to avoid any confusion)
The new file should be included in mkdocs.yml file so it's part of the documentation. Also, you need to test the new docs on your machine using the command mkdocs serve --open

sudeeptarlekar · 2025-10-07T12:23:06Z

Do you think it does makes sense to document export the log, as user can only export and import is not possible.

So Imo adding import search/filters documentation is main thing...

AmmarAbouZor · 2025-10-07T12:39:08Z

Do you think it does makes sense to document export the log, as user can only export and import is not possible.

Correct, sorry used to write export and import together. I would suggest naming the whole page Export Logs

So Imo adding import search/filters documentation is main thing...

I think the current place for importing search and filters is suitable because all filters its related stuff are gathered in on document, making the users able to learn about the exporting and importing filters directly after learning about them.

AmmarAbouZor

The recordings are great thank 💯

I think you misunderstood what I've meant in the last comments. Here are more details:

We need a stand-alone document with the name Export Logs. This should contain info about exporting logs + the assets
We don't need to change anything in search.md document. Export Logs isn't part of it (I was talking about Export/Import Presets in the last comment and though that you wanted to move them to the Exporting document)
We don't need the Exporting stand-alone document

AmmarAbouZor

I've started with the review but I've found out that we still have multiple places where filters are mentioned in the export logs document and where importing filters is removed form filters document, so I don't think this PR is ready for review in this state.

Also, We don't need to break the documentation lines when they reach a certain length, since the web view will wrap them automatically as they fit. Having the breaks in the raw text is a little bit confusing.

docs/exporting.md

AmmarAbouZor

I've added some comments

Also, we don't need to break the lines manually once they've reached a certain length in markdown files.

AmmarAbouZor · 2025-10-13T12:42:36Z

docs/export_logs.md

+**Raw**
+
+1. The filtered results are exported as a binary file.
+2. Useful when user wants to share only filtered logs from Chipmunk.


This can be used to combine logs from different file sources into one binary files. This can be achieved when you add multiple file sources in one session, then the filter results will be from them all and the export will be a combination from concatenated files

AmmarAbouZor · 2025-10-13T12:43:05Z

docs/exporting.md

+### Exporting filters and presets
+
+Along with the logs user can also export the filters for later use and sharing,
+find out more how user can export the filters from Chipmunk
+[here](../search/#importing-exporting-presets)
+


Filters don't belong to this document. I thought that this document is just for exporting logs only

AmmarAbouZor · 2025-10-13T12:43:53Z

docs/exporting.md

+find out more how user can export the filters from Chipmunk
+[here](../search/#importing-exporting-presets)
+
+### Exporting Streams


Maybe ### Exporting Streams' Logs or Export Logs from Streams could be a better fit

AmmarAbouZor · 2025-10-13T12:47:12Z

mkdocs.yml

+  icon:
+    admonition:
+      note: material/note
+      alert: material/alert


I'm curious why we need to add this here?

AmmarAbouZor · 2025-10-13T12:47:56Z

mkdocs.yml

  - Overview: index.md
  - Installation: installation.md
  - Search: search.md
+  - Expor Logs: exporting.md


Let's change the name of the file to export_logs.md to match its title here.
Also, the title has a typo in it Export instead of Expor

AmmarAbouZor · 2025-10-13T12:53:08Z

docs/export_logs.md

+
+### Exporting Streams
+
+Chipmunk allows to render the streams of data from TCP or UDP.


This isn't 100% correct. I would replace it with something like Chipmunk supports parsing and analyzing logs from multiple stream sources. We don't need to start mentioning the sources because we have many TCP, UDP, The output of process commands and serial ports

AmmarAbouZor · 2025-10-13T12:53:48Z

docs/search.md

+
+
+


Too many line-breaks

Chipmunk docs are currently missing the information around import and export of the presets. This commit adds the missing documentaion

AmmarAbouZor

I've found a small change that we don't need. Maybe it got forgotten

AmmarAbouZor · 2026-02-08T20:38:41Z

docs/search.md

 Filters/charts will be associated with an opened file (or stream). Next time the same file (or stream) is opened, filters/charts will be restored.

-At the same time, there are a couple of ways to export/import filters:
+At the same time, there are a couple of ways to export filters:


Why we are removing import here?

sudeeptarlekar requested a review from AmmarAbouZor October 2, 2025 13:03

AmmarAbouZor requested changes Oct 6, 2025

View reviewed changes

sudeeptarlekar force-pushed the task/2417/add_import_export_docs branch from 6d55406 to a956a54 Compare October 7, 2025 13:52

sudeeptarlekar requested a review from AmmarAbouZor October 7, 2025 13:53

AmmarAbouZor requested changes Oct 7, 2025

View reviewed changes

sudeeptarlekar force-pushed the task/2417/add_import_export_docs branch 2 times, most recently from 190c5a6 to cddce71 Compare October 8, 2025 12:55

sudeeptarlekar requested a review from AmmarAbouZor October 8, 2025 12:55

AmmarAbouZor requested changes Oct 8, 2025

View reviewed changes

docs/exporting.md Outdated Show resolved Hide resolved

docs/exporting.md Outdated Show resolved Hide resolved

docs/exporting.md Outdated Show resolved Hide resolved

sudeeptarlekar force-pushed the task/2417/add_import_export_docs branch from fc6ac18 to dc5ef20 Compare October 9, 2025 08:28

sudeeptarlekar requested a review from AmmarAbouZor October 13, 2025 12:11

AmmarAbouZor requested changes Oct 13, 2025

View reviewed changes

sudeeptarlekar added 4 commits February 2, 2026 09:51

Add documentation for import and export functionality in Chipmunk

f46f9ee

Chipmunk docs are currently missing the information around import and export of the presets. This commit adds the missing documentaion

Add import export entry in the mkdocs

4c5b227

Fix import export documentation

63dd8c4

Remove filter details from export logs

776f1bc

sudeeptarlekar force-pushed the task/2417/add_import_export_docs branch from dc5ef20 to 776f1bc Compare February 2, 2026 08:51

Resolve PR comments

cc12d6c

sudeeptarlekar force-pushed the task/2417/add_import_export_docs branch from be71792 to cc12d6c Compare February 2, 2026 14:26

sudeeptarlekar requested a review from AmmarAbouZor February 2, 2026 14:26

AmmarAbouZor requested changes Feb 8, 2026

View reviewed changes


		### Exporting Streams

		Chipmunk allows to render the streams of data from TCP or UDP.

Conversation

sudeeptarlekar commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

AmmarAbouZor left a comment

Choose a reason for hiding this comment

Uh oh!

sudeeptarlekar commented Oct 7, 2025

Uh oh!

AmmarAbouZor commented Oct 7, 2025

Uh oh!

AmmarAbouZor left a comment

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AmmarAbouZor left a comment

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor left a comment

Choose a reason for hiding this comment

Uh oh!

AmmarAbouZor Feb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

sudeeptarlekar commented Oct 2, 2025 •

edited

Loading

AmmarAbouZor Oct 13, 2025 •

edited

Loading