Skip to content

Docs: write for users, not maintainers - #494

Merged
fstubner merged 3 commits into
mainfrom
fix/docs-copy
Oct 2, 2026
Merged

fstubner merged 3 commits into
mainfrom
fix/docs-copy

Conversation

@fstubner

@fstubner fstubner commented Oct 1, 2026

Copy link
Copy Markdown
Owner

First pass of the copy review: the docs pages were partly written to the maintainer.

  • Removed the pages' notes about their own past corrections (result model, core library, interface coverage), design rationale (the black-window section, packet capture, checksums, Packet Capture visibility), and build-pipeline wording ("where the release workflow publishes them", "depending on the release", "clap", "compile-time feature", "OUI").
  • Moved the contributor rules out of the public Core library page. Ownership and compatibility rules were already in docs/ARCHITECTURE.md; the "adding a network capability" steps are added there. The page now links to it.
  • Added the macOS and Linux desktop installs (Homebrew cask, .dmg, .deb, AppImage, AUR), and the macOS first-launch step (Open Anyway; right-click → Open stopped working in macOS 15).
  • Fixed the 0.3.3 Windows signing claim (the app inside the MSI is signed from 0.3.4), the Packet Capture "greyed" vs "opens with guidance" contradiction (checked against App.tsx and PcapUnavailableState.tsx), and the desktop page contradicting itself on mDNS.
  • Updated pages that still described TCP-only scans or an inspect without the OS hint, and "JSON/YAML" where CSV and Markdown exist too. One word, "interfaces", where interface coverage said "surfaces".

Not in this PR: re-capturing the JSON examples (CLI, MCP) from the released 0.3.4 build, which will include the protocol field. That follows the release. The landing-page copy changes are in #472.

The AI-prose Vale style passes on all eleven pages before and after.

Remove the pages' notes about their own past corrections, design rationale, contributor rules and build-pipeline wording; add the macOS and Linux desktop installs and the macOS Open Anyway step; fix the 0.3.3 Windows signing claim and the Packet Capture and mDNS contradictions; describe UDP, versions and OS hints where pages still said TCP only.
@github-actions

github-actions Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Site preview: https://pr-494.netscli-site-preview.pages.dev

Built from 2244aea with NETSCLI_PREVIEW=1 — noindex, and analytics disabled so it does not report into netscli.com's numbers.

Production is unaffected: netscli.com is served from GitHub Pages via pages.yml, which is manual-only.

@fstubner
fstubner merged commit d40f6a6 into main Oct 2, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant