Skip to content

Docs: standardize WiFi page and clarify format-app-doc command. #3467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 1 commit into from
Jun 1, 2026
Merged

Docs: standardize WiFi page and clarify format-app-doc command. #3467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .claude/commands/format-app-doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Any `:::note` blocks that describe input format or input combination rules (e.g.

**Example:**

```
```markdown
### Example inputs

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

### 10. Actions

Place action subsections directly after the screenshot — never inside a wrapping `## Actions` section. This applies to both single-view pages and multi-tab pages:
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:

- **Single-view pages:** `### Toolbar`, `### Context menu`, and `### Keyboard shortcuts` appear directly after the screenshot (and the optional `:::note` from step 9, if present).
- **Single-view pages:** `### Toolbar`, `### Context menu`, and `### Keyboard shortcuts` appear in that location directly after the screenshot flow.
- **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.

Include only the subsections that apply. Omit subsections with no content.
Expand Down Expand Up @@ -129,4 +129,4 @@ Fix obvious typos (e.g. `ipadress` → `IP address`, `Multipe` → `Multiple`) a
- **Omit** any `## Actions` subsection that has no content for this page.
- Preserve all existing links, anchors (`#section-name`), and image references exactly.
- Do not change field types, examples, or possible values.
- Do not add new top-level sections (`##`) that do not exist in the source, except `## Actions`.
- Do not add new top-level sections (`##`) that do not exist in the source.
18 changes: 12 additions & 6 deletions Website/docs/application/wifi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_position: 2
description: "Analyze available WiFi networks with details on channels, signal strength, and encryption. NETworkManager WiFi Analyzer supports 2.4, 5, and 6 GHz bands."
description: "Analyze available WiFi networks, including channels, signal strength, and encryption details across the 2.4, 5, and 6 GHz bands."
keywords:
[
NETworkManager,
Expand All @@ -16,19 +16,25 @@ keywords:

# WiFi

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

Hidden wireless networks are shown as `Hidden Network`.

:::info

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.

:::

## WiFi

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.
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.

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.
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.

:::note

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

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

Expand All @@ -53,7 +59,7 @@ Open `Windows Settings > Privacy & security > Location`, enable access for Deskt

## Channels

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

The tab is split into two sub-tabs:

Expand Down
Loading