diff --git a/README.md b/README.md index 5a0ab84..c2d322f 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,10 @@ Network switch port discovery tool. Captures CDP (Cisco Discovery Protocol), LLD ๐Ÿ“– **Docs:** ยท ๐Ÿ“ [**Changelog**](CHANGELOG.md) +

+ PortFinder on macOS showing a captured LLDP result +

+ > **4.x is the pure-Rust rewrite.** Zed's [gpui](https://www.gpui.rs/) > replaces the Tauri 2 + Svelte 5 stack from the 3.x line, which is > preserved on the [`tauri-version`](https://github.com/packetThrower/PortFinder/tree/tauri-version) diff --git a/docs-next/astro.config.mjs b/docs-next/astro.config.mjs index afc62f5..4101a30 100644 --- a/docs-next/astro.config.mjs +++ b/docs-next/astro.config.mjs @@ -19,11 +19,10 @@ export default defineConfig({ customCss: ['./src/styles/theme.css'], components: { Hero: './src/components/Hero.astro', - // Adds a "โ† packetThrower" back-link pill to the - // left of the default site title. The default - // component (logo + wordmark) is still rendered - // alongside it โ€” see SiteTitle.astro. - SiteTitle: './src/components/SiteTitle.astro', + // Adds "โ† packetThrower" + "Docs" pills to the + // top-right, left of the GitHub icon โ€” same pattern + // as Baudrun's docs site. See SocialIcons.astro. + SocialIcons: './src/components/SocialIcons.astro', }, social: [ { diff --git a/docs-next/public/screenshots/macos.png b/docs-next/public/screenshots/macos.png index 450a0be..0392d60 100644 Binary files a/docs-next/public/screenshots/macos.png and b/docs-next/public/screenshots/macos.png differ diff --git a/docs-next/public/screenshots/macos_settings.png b/docs-next/public/screenshots/macos_settings.png new file mode 100644 index 0000000..1da375e Binary files /dev/null and b/docs-next/public/screenshots/macos_settings.png differ diff --git a/docs-next/public/screenshots/macos_sniffing.png b/docs-next/public/screenshots/macos_sniffing.png new file mode 100644 index 0000000..11d04b9 Binary files /dev/null and b/docs-next/public/screenshots/macos_sniffing.png differ diff --git a/docs-next/public/screenshots/macos_start.png b/docs-next/public/screenshots/macos_start.png new file mode 100644 index 0000000..d7a9a88 Binary files /dev/null and b/docs-next/public/screenshots/macos_start.png differ diff --git a/docs-next/src/components/SiteTitle.astro b/docs-next/src/components/SiteTitle.astro deleted file mode 100644 index 4eabc4b..0000000 --- a/docs-next/src/components/SiteTitle.astro +++ /dev/null @@ -1,84 +0,0 @@ ---- -// Overrides Starlight's default `SiteTitle` to prepend a pill- -// shaped "โ† packetThrower" back-link that returns visitors to -// the parent landing page at https://packetthrower.github.io/. -// The default site title (logo + PortFinder wordmark) still -// renders to the right of the back-link, so brand presence on -// the docs site itself is unchanged. -// -// Visual reference: Etch341's Mintlify site has the same -// pattern in its top nav โ€” the back-link sits to the left of -// the title and gives visitors a clean "this is part of a -// larger thing" affordance without taking over the top bar. -// -// The default component reads everything it needs from -// `Astro.locals.starlightRoute` + the virtual user-config -// module, so no prop forwarding is needed. -import Default from '@astrojs/starlight/components/SiteTitle.astro'; ---- - -
- - - packetThrower - - -
- - diff --git a/docs-next/src/components/SocialIcons.astro b/docs-next/src/components/SocialIcons.astro new file mode 100644 index 0000000..f62259c --- /dev/null +++ b/docs-next/src/components/SocialIcons.astro @@ -0,0 +1,47 @@ +--- +// Override of Starlight's SocialIcons component. Renders two +// quick-access pills on the left โ€” a "โ† packetThrower" back-link +// to the parent landing page, then a "Docs" pill to /install/ โ€” +// then defers to Starlight's default rendering (the GitHub icon, +// etc.) for the rest. Wraps rather than re-implements so future +// Starlight versions that change the social-icon pipeline still +// work โ€” we only own the `.pf-nav-pill` extras. +// +// The back-link is an absolute URL on purpose: Astro's configured +// `base` is `/PortFinder/`, so a relative `/` would resolve to +// `/PortFinder/` (this site's own root). The absolute form skips +// the base prefix and reaches the actual parent at +// https://packetthrower.github.io/. +import Default from '@astrojs/starlight/components/SocialIcons.astro'; +--- + + + packetThrower + + + + Docs + + + + + diff --git a/docs-next/src/content/docs/install.mdx b/docs-next/src/content/docs/install.mdx index 90e0093..04f623c 100644 --- a/docs-next/src/content/docs/install.mdx +++ b/docs-next/src/content/docs/install.mdx @@ -22,6 +22,8 @@ Pre-built binaries for every release live on the [Releases page](https://github. ### Homebrew (recommended) ```bash +brew tap packetThrower/tap +brew trust packetThrower/tap # Homebrew 6.0.0+: trust the tap before installing brew install --cask packetThrower/tap/portfinder ``` diff --git a/docs-next/src/content/docs/usage/gui.mdx b/docs-next/src/content/docs/usage/gui.mdx index 216100e..47fb53e 100644 --- a/docs-next/src/content/docs/usage/gui.mdx +++ b/docs-next/src/content/docs/usage/gui.mdx @@ -12,16 +12,31 @@ import { Tabs, TabItem } from '@astrojs/starlight/components'; 3. **Click Start.** Most switches send a discovery packet every 30โ€“60 seconds, so it usually takes a few seconds for the first frame to arrive. 4. **Read the result.** Switch name, IP, port, VLAN, voice VLAN, MTU, and model populate the result card. -## On each platform - -Native widgets per platform โ€” same workflow, different chrome. +Each stage, on macOS: - + + +![PortFinder ready to capture โ€” interface and protocol selected](/PortFinder/screenshots/macos_start.png) + + + + +![PortFinder capturing โ€” progress bar running, Stop button active](/PortFinder/screenshots/macos_sniffing.png) + + + -![PortFinder on macOS](/PortFinder/screenshots/macos.png) +![PortFinder showing a captured LLDP result](/PortFinder/screenshots/macos.png) + + +## On each platform + +Same workflow, different chrome โ€” macOS is shown above. + + ![PortFinder on Windows](/PortFinder/screenshots/windows.png)