From 868648393bb7573ca152b2fae65212d52fe55099 Mon Sep 17 00:00:00 2001
From: girst <girst@users.noreply.github.com>
Date: Fri, 30 Oct 2020 17:38:06 +0100
Subject: [PATCH] update known bugs

- fission/oop-iframes semi-supported now
- document behaviour after installation
---
 documentation/known-bugs.md | 29 ++++++++++++++++++++++-------
 1 file changed, 22 insertions(+), 7 deletions(-)

diff --git a/documentation/known-bugs.md b/documentation/known-bugs.md
index ff6c8d7..231de6d 100644
--- a/documentation/known-bugs.md
+++ b/documentation/known-bugs.md
@@ -7,7 +7,7 @@ problems that affect VimFx when run on versions of Firefox we support
 
 ## Responsive Design Mode
 
-**Affected**: Firefox <= 78
+**Affected**: Firefox <= 78  
 **Workaround**: `devtools.responsive.browserUI.enabled;true`
 
 Launching the (old) Responsive Design Mode breaks VimFx for this tab. The only
@@ -21,19 +21,34 @@ The [new RDM] does not have this bug; it can be enabled by switching
 
 ## Fission
 
-**Affected**: (future versions)
+**Affected**: (future versions)  
 **Workaround**: `fission.autostart;false`
 
 With [Fission] enabled, VimFx can't inspect out-of-process iframes.
 
 Fission is not (yet) turned on by default, but can be disabled by switching
-`fission.autostart` to `false` in `about:config`. A [patch is in the works] that
-at least prevents VimFx from crashing, but for full OOP-iframe support it is way
-too early.
-<!-- As of May 2020, not even Firefox' DevTools support it, let alone other Vim
+`fission.autostart` to `false` in `about:config`. With Fission, VimFx cannot
+place hint markers or determine whether an editable element is active in iframes
+from a different domain to the top document. We will instead enter insert mode
+whenever such an iframe is active (so input elements are usable; click outside
+the iframe to let VimFx re-gain control).
+
+<!-- For full OOP-iframe support it is way too early.
+As of May 2020, not even Firefox' DevTools support it, let alone other Vim
 like (web)extensions. Further, I suspect that to avoid a huge rewrite of how
 VimFx handles element discovery and interaction, we'd need cross-process-DOM
 APIs that just don't exist right now. -->
 
 [Fission]: https://wiki.mozilla.org/Project_Fission
-[patch is in the works]: https://git.gir.st/VimFx.git/shortlog/refs/heads/fission-v2
+
+## VimFx behaves broken after installation
+
+**Affected**: all supported versions  
+**Solution**: restart browser
+
+For some as-of-yet undetermined reason, the addon sometimes breaks after
+installation (or upgrade)<!-- possibly Gecko internals changed and the
+BootstrapLoader is failing -->. Fastest way to restart Firefox is pressing
+`<Ctrl-Shift-j>` to open the browser console, then `<Ctrl-Alt-r>` to restart.
+Alternatively, navigate to `about:profiles` and hit the *Restart normally*
+button.
-- 
2.39.3