π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
docs(contributing): resync the source tree with what is actually there
davbioa7bb4fb44258
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 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 |