Skip to content

Commit 807cf1c

Browse files
Docs: standardize WiFi page and clarify format-app-doc command.
Align WiFi documentation with the project page structure and resolve conflicting action-placement rules in the formatting command. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent b64e132 commit 807cf1c

2 files changed

Lines changed: 17 additions & 11 deletions

File tree

‎.claude/commands/format-app-doc.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Any `:::note` blocks that describe input format or input combination rules (e.g.
4040

4141
**Example:**
4242

43-
```
43+
```markdown
4444
### Example inputs
4545

4646
| Host | Type | Description |
@@ -61,9 +61,9 @@ Only for standalone application behavior facts that don't fit elsewhere (e.g. au
6161

6262
### 10. Actions
6363

64-
Place action subsections directly after the screenshot — never inside a wrapping `## Actions` section. This applies to both single-view pages and multi-tab pages:
64+
Place action subsections directly after `### Example inputs` (if present) and the optional `:::note` from step 9. If those sections are not present, place actions directly after the screenshot. Never wrap them in a `## Actions` section. This applies to both single-view pages and multi-tab pages:
6565

66-
- **Single-view pages:** `### Toolbar`, `### Context menu`, and `### Keyboard shortcuts` appear directly after the screenshot (and the optional `:::note` from step 9, if present).
66+
- **Single-view pages:** `### Toolbar`, `### Context menu`, and `### Keyboard shortcuts` appear in that location directly after the screenshot flow.
6767
- **Multi-tab pages** (page organized as `## Tab Name` sections, each with its own screenshot): place the same subsections inline within each tab section, directly after its screenshot. Simple single-action notes (e.g. "Right-click on the result to copy the information.") can remain as `:::note` blocks after the screenshot instead of a full subsection.
6868

6969
Include only the subsections that apply. Omit subsections with no content.
@@ -129,4 +129,4 @@ Fix obvious typos (e.g. `ipadress` → `IP address`, `Multipe` → `Multiple`) a
129129
- **Omit** any `## Actions` subsection that has no content for this page.
130130
- Preserve all existing links, anchors (`#section-name`), and image references exactly.
131131
- Do not change field types, examples, or possible values.
132-
- Do not add new top-level sections (`##`) that do not exist in the source, except `## Actions`.
132+
- Do not add new top-level sections (`##`) that do not exist in the source.

‎Website/docs/application/wifi.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_position: 2
3-
description: "Analyze available WiFi networks with details on channels, signal strength, and encryption. NETworkManager WiFi Analyzer supports 2.4, 5, and 6 GHz bands."
3+
description: "Analyze available WiFi networks, including channels, signal strength, and encryption details across the 2.4, 5, and 6 GHz bands."
44
keywords:
55
[
66
NETworkManager,
@@ -16,27 +16,33 @@ keywords:
1616

1717
# WiFi
1818

19-
The **WiFi** tool shows all available wireless networks with details such as channel, signal strength, and encryption type.
19+
The **WiFi** tool shows available wireless networks, including channel, signal strength, and encryption details.
2020

2121
Hidden wireless networks are shown as `Hidden Network`.
2222

23+
:::info
24+
25+
Wi-Fi is a wireless networking technology based on IEEE 802.11 standards. Access points periodically advertise network information (such as SSID and security capabilities), which clients can scan and display.
26+
27+
:::
28+
2329
## WiFi
2430

25-
On the **WiFi** tab, you can select which wireless network adapter is used to scan for wireless networks. Wireless networks can be filtered by 2.4 GHz, 5 GHz, and 6 GHz.
31+
On the **WiFi** tab, you can select which wireless adapter is used for scanning. Results can be filtered by the 2.4 GHz, 5 GHz, and 6 GHz bands.
2632

27-
In the search field, you can filter the wireless networks by `SSID`, `Security`, `Frequency`, `Channel`, `BSSID (MAC Address)`, `Vendor`, and `Phy kind`. The search is case-insensitive.
33+
In the search field, you can filter wireless networks by `SSID`, `Security`, `Frequency`, `Channel`, `BSSID (MAC Address)`, `Vendor`, and `PHY kind`. Search is case-insensitive.
2834

2935
:::note
3036

31-
Starting with Windows 11 24H2, you need to allow access to the Wi-Fi adapter.
37+
Starting with Windows 11 24H2, you must allow access to the Wi-Fi adapter.
3238

3339
Open `Windows Settings > Privacy & security > Location`, enable access for Desktop Apps / NETworkManager, then restart the application.
3440

3541
:::
3642

3743
:::note
3844

39-
Due to limitations of the `Windows.Devices.WiFi` API, the channel bandwidth cannot be detected.
45+
Due to limitations of the `Windows.Devices.WiFi` API, channel bandwidth cannot be detected.
4046

4147
:::
4248

@@ -59,7 +65,7 @@ Due to limitations of the `Windows.Devices.WiFi` API, the channel bandwidth cann
5965

6066
## Channels
6167

62-
On the **Channels** tab, all wireless networks of the selected wireless network adapter are displayed in a graphical view with channel and signal strength. This can be useful to identify overlapping wireless networks that do not originate from the same access point.
68+
On the **Channels** tab, wireless networks for the selected adapter are shown in a graphical view by channel and signal strength. This helps identify overlapping wireless networks that do not originate from the same access point.
6369

6470
![WiFi - Channel](../img/wifi--channel.png)
6571

0 commit comments

Comments
 (0)