Docs: write for users, not maintainers - #494
Merged
Merged
Conversation
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.
|
Site preview: https://pr-494.netscli-site-preview.pages.dev Built from 2244aea with Production is unaffected: netscli.com is served from GitHub Pages via |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
First pass of the copy review: the docs pages were partly written to the maintainer.
docs/ARCHITECTURE.md; the "adding a network capability" steps are added there. The page now links to it..dmg,.deb, AppImage, AUR), and the macOS first-launch step (Open Anyway; right-click → Open stopped working in macOS 15).App.tsxandPcapUnavailableState.tsx), and the desktop page contradicting itself on mDNS.Not in this PR: re-capturing the JSON examples (CLI, MCP) from the released 0.3.4 build, which will include the
protocolfield. 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.