Skip to content

armgit / mimik

Public Imported from GitHub
0

🎬 A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots πŸ“–

docs(contributing): resync the source tree with what is actually there

davbioa7bb4fb44258
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8dff0c3..269c464 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -68,19 +68,21 @@ One rule Biome cannot check: do not write comments. Name things so the code expl
```
src/
β”œβ”€β”€ core/ # Business logic (no UI dependencies)
-β”‚ β”œβ”€β”€ capture/ # Recording pipeline (events, AI, DOM context)
+β”‚ β”œβ”€β”€ capture/ # Recording pipeline (events, AI, voice, DOM context)
β”‚ β”œβ”€β”€ blur/ # Smart blur (regex presets, DOM scanner, panel)
-β”‚ β”œβ”€β”€ export/ # HTML, PDF, Markdown generators
+β”‚ β”œβ”€β”€ export/ # HTML, PDF, DOCX, Markdown, video, GIF generators
+β”‚ β”œβ”€β”€ transfer/ # .mimik bundles (export/import a guide between browsers)
β”‚ β”œβ”€β”€ guideme/ # Guide replay (finder, overlay, session)
+β”‚ β”œβ”€β”€ screenshot/ # Rendering, annotations, geometry
β”‚ └── guides/ # Data layer (types, Dexie DB, CRUD)
β”œβ”€β”€ entrypoints/ # WXT extension entry points
β”‚ β”œβ”€β”€ background/ # Service worker: state machine + message handlers
-β”‚ β”œβ”€β”€ content.ts # Content script: event capture + rrweb
+β”‚ β”œβ”€β”€ content.ts # Content script: event capture + capture session
β”‚ β”œβ”€β”€ sidepanel/ # Side panel React mount
β”‚ β”œβ”€β”€ fullview/ # Full-page dashboard mount
β”‚ β”œβ”€β”€ onboarding/ # First-install wizard
β”‚ └── options/ # Settings page mount
-β”œβ”€β”€ locales/ # YAML translation files (en, es, pt-BR, fr)
+β”œβ”€β”€ locales/ # YAML translation files (en, de, es, fr, pt-BR, zh-CN)
β”œβ”€β”€ lib/ # Shared utilities (messaging, port, browser API)
β”œβ”€β”€ stores/ # Zustand state stores
└── ui/ # React components
@@ -99,7 +101,7 @@ src/
| Storage | [Dexie.js](https://dexie.org) (IndexedDB) |
| Messaging | [webext-core](https://webext-core.aklinker1.io) |
| Session recording | [rrweb](https://www.rrweb.io) |
-| Export | [jsPDF](https://github.com/parallax/jsPDF) + HTML/Markdown |
+| Export | [jsPDF](https://github.com/parallax/jsPDF), [docx](https://github.com/dolanmiu/docx), [mediabunny](https://github.com/Vanilagy/mediabunny), [gifenc](https://github.com/mattdesl/gifenc), [fflate](https://github.com/101arrowz/fflate) + HTML/Markdown |
| AI (optional) | [Vercel AI SDK](https://sdk.vercel.ai) (OpenAI, Anthropic) |
| i18n | [@wxt-dev/i18n](https://wxt.dev) + YAML locales |
| Testing | [Vitest](https://vitest.dev) + Testing Library |