docs: Add troubleshooting (#179)

The troubleshooting resolves the following issues: - The addon is not working on the Firefox (#164) - Url tooltip is hiding the console (ueokande/vim-vixen#203)
ueokande · Jul 15, 2023 · 3ab7bc8 · 3ab7bc8
1 parent d0ea50d
commit 3ab7bc8
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 20 deletions.
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -18,7 +18,7 @@
 
 <body>
   <header class='header-wide'>
-    <h1><a href='index.html'>Vimmatic</a></h1>
+    <h1><a href='.'>Vimmatic</a></h1>
     <ul>
       <li><a target="_blank" rel="noopener" href='https://github.com/ueokande/vimmatic'>GitHub</a></li>
       <li><a target="_blank" rel="noopener" href='https://addons.mozilla.org/firefox/addon/vimmatic/'>Firefox Add-ons</a></li>
@@ -27,18 +27,19 @@ <h1><a href='index.html'>Vimmatic</a></h1>
   </header>
 
   <header class='header-mobile'>
-    <h1><a href='index.html'>Vimmatic</a></h1>
+    <h1><a href='.'>Vimmatic</a></h1>
   </header>
 
   <aside class='aside-wide'>
     <h1>Guide</h1>
     <ul>
-      <li><a href='./keymaps.html'>Keymaps</a></li>
-      <li><a href='./console_commands.html'>Console commands</a></li>
-      <li><a href='./blacklist.html'>Blacklist</a></li>
-      <li><a href='./search_engines.html'>Search engines</a></li>
-      <li><a href='./properties.html'>Properties</a></li>
-      <li><a href='./styles.html'>Custom Styles</a></li>
+      <li><a href='./keymaps'>Keymaps</a></li>
+      <li><a href='./console_commands'>Console commands</a></li>
+      <li><a href='./blacklist'>Blacklist</a></li>
+      <li><a href='./search_engines'>Search engines</a></li>
+      <li><a href='./properties'>Properties</a></li>
+      <li><a href='./styles'>Custom Styles</a></li>
+      <li><a href='./troubleshooting'>Troubleshooting</a></li>
     </ul>
   </aside>
 
@@ -49,12 +50,13 @@ <h1>Guide</h1>
 
   <aside class='aside-mobile'>
     <ul>
-      <li><a href='./keymaps.html'>Keymaps</a></li>
-      <li><a href='./console_commands.html'>Console commands</a></li>
-      <li><a href='./blacklist.html'>Blacklist</a></li>
-      <li><a href='./search_engines.html'>Search engines</a></li>
-      <li><a href='./properties.html'>Properties</a></li>
-      <li><a href='./styles.html'>Custom Styles</a></li>
+      <li><a href='./keymaps'>Keymaps</a></li>
+      <li><a href='./console_commands'>Console commands</a></li>
+      <li><a href='./blacklist'>Blacklist</a></li>
+      <li><a href='./search_engines'>Search engines</a></li>
+      <li><a href='./properties'>Properties</a></li>
+      <li><a href='./styles'>Custom Styles</a></li>
+      <li><a href='./troubleshooting'>Troubleshooting</a></li>
       <li class='separator'></li>
       <li><a target="_blank" rel="noopener" href='https://github.com/ueokande/vimmatic'>GitHub</a></li>
       <li><a target="_blank" rel="noopener" href='https://addons.mozilla.org/firefox/addon/vimmatic/'>Firefox Add-ons</a></li>

diff --git a/docs/assets/images/Access_your_data_for_all_websites.png b/docs/assets/images/Access_your_data_for_all_websites.png
diff --git a/docs/console_commands.md b/docs/console_commands.md
@@ -37,9 +37,9 @@ To use a search engine other than the default, specify the search engine to use
 :open yahoo How to contribute to Vimmatic
 ```
 
-To adjust the default search-engine and add/remove search engines, see the [search engines](./search_engines.md) section.
+To adjust the default search-engine and add/remove search engines, see the [search engines](./search_engines) section.
 
-Use <kbd>Tab</kbd> to select from the autocomplete suggestions. To configure this, set the [`complete` property.](./properties.html#complete)
+Use <kbd>Tab</kbd> to select from the autocomplete suggestions. To configure this, set the [`complete` property.](./properties#complete)
 
 ## `:tabopen`
 
@@ -96,5 +96,5 @@ the current page.
 ## `:set`
 
 The `:set` command can be used to temporarily override properties in the
-console. See the [properties](./properties.md) section for more details on
+console. See the [properties](./properties) section for more details on
 the available properties.
diff --git a/docs/index.md b/docs/index.md
@@ -47,7 +47,7 @@ tabs, use <kbd>u</kbd>.
 To open a link, press <kbd>f</kbd> to enter the **follow mode** to select a
 link.  Then you can select links by alphabetic keys.
 
-See also [Keymaps](./keymaps.md) for more detailed of keymaps.
+See also [Keymaps](./keymaps) for more detailed of keymaps.
 
 ### Using commands
 
@@ -68,7 +68,7 @@ or search keywords with search engine (such as Google) like:
 
 The console completes commands by your input.  Press <kbd>Tab</kbd> and <kbd>
 Shift</kbd>+<kbd>Tab</kbd> to select next and previous items, respectively.
-You can see all commands on [Console commands](./console_commands.md).
+You can see all commands on [Console commands](./console_commands).
 
 ## Copyright
 

diff --git a/docs/keymaps.md b/docs/keymaps.md
@@ -54,7 +54,7 @@ numeric marks (`[A-Z0-9]`) store the position and the tab.
 - <kbd>b</kbd>: select tabs by URL or title
 - <kbd>a</kbd>: add the current page to your bookmarks
 
-See the [console commands](./console_commands.md) section for a more detailed description.
+See the [console commands](./console_commands) section for a more detailed description.
 
 ## Zoom
 

diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -0,0 +1,39 @@
+---
+title: Troubleshooting
+---
+
+# Troubleshooting
+
+## The addon is not working on the Firefox
+
+The firefox addon with Manifest V3 requires optional permissions to work well
+on any website. You can find it on `Permissions` section of `Vimmatic` settings
+on the `about:addons` page.  Please make sure that the `Access your data for
+all websites` is enabled.
+
+![Access your data for all websites is enables](./assets/images/Access_your_data_for_all_websites.png)
+
+## Url tooltip is hiding the console
+
+When them mouse cursor hovers over a link, a tooltip shows up in the bottom of
+the screen.  It can hide the console of the addon.  You can remove this tooltip
+by adding custom styles into `userChrome.css` file.  Please follow the steps
+below:
+
+1. Enable the `toolkit.legacyUserProfileCustomizations.stylesheets` option in
+   the `about:config` page.
+2. Create `userChrome.css` file in the `chrome` directory under the profile
+   directory.  The location of the `userChrome.css` should be `<profile
+   directory>/chrome/userChrome.css`.  You can find the location of the profile
+   directory at the `Profile Directory` section on the `about:support` page.
+3. Add the following content into the `userChrome.css` file:
+
+   ```css
+   @namespace url("http://www.mozilla.org/keymaster/gatekeeper/there.is.only.xul");
+
+   #statuspanel {
+     display: none !important;
+   }
+   ```
+
+4. Restart the browser.