From ec4b5b6014c39f654e40b94e2d15a0afa4c4e825 Mon Sep 17 00:00:00 2001 From: arios4k Date: Sun, 15 Nov 2026 09:59:55 -0800 Subject: [PATCH] Manual: snap install commands and tables render as code blocks and tables Code blocks and tables nested inside numbered steps came out as run-on text (the builder doesn't support them inside list items). The snap's after-install steps are now bold-numbered paragraphs with the commands in code blocks, the Keep Awake table moves out of its list item, and an ordered list that resumes after a table keeps its numbering. Co-Authored-By: Claude Opus 5.5 --- docs/manual/build.py | 5 ++- docs/manual/pages/awake.md | 14 ++++---- docs/manual/pages/install.md | 66 ++++++++++++++++++++++-------------- 3 files changed, 51 insertions(+), 34 deletions(-) diff --git a/docs/manual/build.py b/docs/manual/build.py index 3e4634a..bbbdf34 100644 --- a/docs/manual/build.py +++ b/docs/manual/build.py @@ -127,6 +127,8 @@ def uid(t): i += 1 out.append("") elif re.match(r"\d+\. ", line): + # A list that resumes after a table or code block keeps its numbering. + first = int(re.match(r"(\d+)\. ", line).group(1)) items = [] while i < len(lines) and (re.match(r"\d+\. ", lines[i]) or (lines[i].startswith(" ") and lines[i].strip() and items)): if re.match(r"\d+\. ", lines[i]): @@ -134,7 +136,8 @@ def uid(t): else: items[-1] += " " + lines[i].strip() i += 1 - out.append("
    " + "".join(f"
  1. {inline(x)}
  2. " for x in items) + "
") + start = f' start="{first}"' if first != 1 else "" + out.append(f"" + "".join(f"
  • {inline(x)}
  • " for x in items) + "") else: buf = [] while i < len(lines) and lines[i].strip() and not re.match(r"(#{1,4} |```|>|\||\s*[-*] |\d+\. |!\[)", lines[i]): diff --git a/docs/manual/pages/awake.md b/docs/manual/pages/awake.md index ce8c0ee..2baf971 100644 --- a/docs/manual/pages/awake.md +++ b/docs/manual/pages/awake.md @@ -9,13 +9,13 @@ Watching a film, presenting, or waiting for a long download? Keep Awake stops yo 1. Open **Keep Awake**. 2. Choose how long in the **For** list: - | Choice | Length | - |---|---| - | 30 minutes | 30 minutes | - | 1 hour | 60 minutes | - | 2 hours | 120 minutes | - | 4 hours | 240 minutes | - | Until turned off | no time limit | +| Choice | Length | +|---|---| +| 30 minutes | 30 minutes | +| 1 hour | 60 minutes | +| 2 hours | 120 minutes | +| 4 hours | 240 minutes | +| Until turned off | no time limit | 3. Turn the switch on. The status changes to **Keep Awake is on**, and when a timer is running it shows the time left. 4. Turn the switch off whenever you are done: the status says **Keep Awake is off**. diff --git a/docs/manual/pages/install.md b/docs/manual/pages/install.md index 24bc6ac..33f94b8 100644 --- a/docs/manual/pages/install.md +++ b/docs/manual/pages/install.md @@ -41,31 +41,41 @@ Snap updates arrive automatically. ### After installing the snap -1. **Open Voltkit once** from your apps. It starts its background service, sets it to start at every login, and adds its keyboard shortcuts. -2. **Allow the permissions the snap doesn't get automatically.** Run these once in a terminal, or switch them on in your app store under **Voltkit → Permissions**: - - ```bash - sudo snap connect voltkit:removable-media - sudo snap connect voltkit:system-observe - sudo snap connect voltkit:mount-observe - sudo snap connect voltkit:process-control - sudo snap connect voltkit:log-observe - sudo snap connect voltkit:login-session-observe - sudo snap connect voltkit:hardware-observe - ``` - - | Permission | Lets Voltkit | - |---|---| - | `removable-media` | use files on USB drives and other external disks (Compressor, Batch Rename, Image Resizer) | - | `system-observe` | see which apps have files and ports open, and read drivers and the system's state (What's Using This?, System Report) | - | `mount-observe` | list the drives that are connected (What's Using This?, System Report) | - | `process-control` | close the apps that keep something busy (What's Using This?) | - | `log-observe` | read the sleep history (Why Didn't It Sleep?) | - | `login-session-observe` | see what is keeping the computer awake (Why Didn't It Sleep?) | - | `hardware-observe` | read hardware details, temperatures and fans (System Report, GPU Tuner) | - - You can connect only the ones for the tools you use. Nothing else needs connecting: screenshots, the eyedropper, the clipboard and pasting go through the desktop's portals, which the snap may use without asking. -3. **Check** with `voltkit doctor`: its *Snap Store version* section lists each permission and whether it is connected. +**1. Open Voltkit once** from your apps. It starts its background service, sets it to start at every login, and adds its keyboard shortcuts. + +**2. Allow the permissions the snap doesn't get automatically.** Copy these commands into a terminal and press Enter (they ask for your password once): + +```bash +sudo snap connect voltkit:removable-media +sudo snap connect voltkit:system-observe +sudo snap connect voltkit:mount-observe +sudo snap connect voltkit:process-control +sudo snap connect voltkit:log-observe +sudo snap connect voltkit:login-session-observe +sudo snap connect voltkit:hardware-observe +``` + +Instead of the terminal, you can also switch them on in your app store under **Voltkit → Permissions**. What each one is for: + +| Permission | Lets Voltkit | +|---|---| +| `removable-media` | use files on USB drives and other external disks (Compressor, Batch Rename, Image Resizer) | +| `system-observe` | see which apps have files and ports open, and read drivers and the system's state (What's Using This?, System Report) | +| `mount-observe` | list the drives that are connected (What's Using This?, System Report) | +| `process-control` | close the apps that keep something busy (What's Using This?) | +| `log-observe` | read the sleep history (Why Didn't It Sleep?) | +| `login-session-observe` | see what is keeping the computer awake (Why Didn't It Sleep?) | +| `hardware-observe` | read hardware details, temperatures and fans (System Report, GPU Tuner) | + +You can connect only the ones for the tools you use. Nothing else needs connecting: screenshots, the eyedropper, the clipboard and pasting go through the desktop's portals, which the snap may use without asking. + +**3. Check** that everything is connected: + +```bash +voltkit doctor +``` + +Its *Snap Store version* section lists each permission and whether it is connected. ### What works only with apt or Fedora @@ -79,7 +89,11 @@ Snap updates arrive automatically. | [What's Using This?](using) | Seeing and closing apps that belong to other users or to the system. | | [Why Didn't It Sleep?](sleep) | Stopping a USB device from waking the computer. | -These need the administrator password (Voltkit asks through `pkexec`), write system files or read the desktop's permission store, and a snap is allowed none of them. To use them, remove the snap (`sudo snap remove voltkit`) and install with [apt](#ubuntu-debian-and-derivatives) or [Fedora](#fedora) instead. +These need the administrator password (Voltkit asks through `pkexec`), write system files or read the desktop's permission store, and a snap is allowed none of them. To use them, remove the snap and install with [apt](#ubuntu-debian-and-derivatives) or [Fedora](#fedora) instead: + +```bash +sudo snap remove voltkit +``` ## From source