Repository navigation
Closed
Description
Context
Main moved far past the last documented release surface while version metadata stayed frozen:
CHANGELOG.mdtops at [1.3.0] - 2026-07-30; missing module split (refactor: split 2,676-line psm1 into 33 per-function files (#31) #55), NetBox/Mermaid/nmap/discovery/CSV (Discovery works after Install-Module, not only from the cloned repo #35–The node inventory exports as CSV for spreadsheets and ticket systems #41), bridge FDB (feat: add Get-SnmpBridgeNeighbors for L2 edge discovery via forwarding tables (#39) #56), IPv6 (feat: IPv6 support in subnet matching, ARP discovery, and export (#40) #57), reachability tri-state (Test-DeviceReachability marks an ICMP-blocked host identically to a host that does not exist #28), SNMP outcomes (SNMP discovery downgrades every failure to a warning, so a partial topology looks like a complete one #30), etc.- Manifest still
ModuleVersion = '1.3.0'with ReleaseNotes describing only 1.3.0 hardening — no IPv6, noGet-SnmpBridgeNeighbors, no new exporters. README.md“Repository Layout” still shows a singleNetDiagram-PS.psm1implementation file (pre-refactor: split 2,676-line psm1 into 33 per-function files (#31) #55). Inventory section still says IPv4-only / IPv6 rejected even after feat: IPv6 support in subnet matching, ARP discovery, and export (#40) #57 ARP+subnet support.STRUCTURE.mdPublic list omitsGet-SnmpBridgeNeighbors.ps1.
What
Documentation and release-note honesty pass (no Gallery publish required in this issue):
- Add a new CHANGELOG section (e.g. Unreleased or next semver heading) covering post-1.3.0 main work grouped by Added/Changed/Fixed.
- Refresh manifest
ReleaseNotes(and Tags if useful, e.g. IPv6) to match; leave version bump decision to release prep unless already decided. - Fix README layout tree to Public/Private loader model; point to STRUCTURE.md.
- Rewrite inventory contract wording to match actual behavior after feat: IPv6 support in subnet matching, ARP discovery, and export (#40) #57 and any concurrent Import-Inventory dual-stack work.
- Add L2-FDB to diagram confidence docs; ensure Available Commands table lists all exported functions.
- Update STRUCTURE.md Public file list to include
Get-SnmpBridgeNeighbors.ps1.
Why it matters
Users and eng decide from README/CHANGELOG what the module can do. Stale “IPv4-only” and a monolithic layout tree actively mis-teach the post-#57 tree.
Acceptance criteria
- CHANGELOG documents refactor: split 2,676-line psm1 into 33 per-function files (#31) #55–feat: IPv6 support in subnet matching, ARP discovery, and export (#40) #57 and the other merged 1.0/interop features currently on main.
- README layout matches STRUCTURE.md (loader + Public/Private).
- README inventory / IPv6 wording matches code on main (no “silently IPv4-only with no mention” drift).
- STRUCTURE.md lists every file under Public/ including bridge neighbors.
- Manifest ReleaseNotes mention IPv6 subnet/ARP support and Get-SnmpBridgeNeighbors at minimum.
- Available Commands table includes every
FunctionsToExportentry.
Out of scope
Tagging a Gallery release / publish workflow (separate). Code behavior changes beyond docs-facing string updates in help comments if needed for consistency.
Activity
docs: sync README/CHANGELOG/STRUCTURE after #55–#58 (#60)
docs: sync README/CHANGELOG/STRUCTURE after #55–#58 (#60) (#70)