Skip to content

Docs/manifest: sync README, CHANGELOG, STRUCTURE after #55–#57 feature land #60

Closed

Description

@jacobyoby

Context

Main moved far past the last documented release surface while version metadata stayed frozen:

What

Documentation and release-note honesty pass (no Gallery publish required in this issue):

  1. Add a new CHANGELOG section (e.g. Unreleased or next semver heading) covering post-1.3.0 main work grouped by Added/Changed/Fixed.
  2. Refresh manifest ReleaseNotes (and Tags if useful, e.g. IPv6) to match; leave version bump decision to release prep unless already decided.
  3. Fix README layout tree to Public/Private loader model; point to STRUCTURE.md.
  4. 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.
  5. Add L2-FDB to diagram confidence docs; ensure Available Commands table lists all exported functions.
  6. 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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions