Skip to content

Update README with demo section, version compatibility table, and accurate ASN notes - #16

Merged
Jackass4life merged 2 commits into
mainfrom
copilot/update-readme
Mar 23, 2026
Merged

Update README with demo section, version compatibility table, and accurate ASN notes#16
Jackass4life merged 2 commits into
mainfrom
copilot/update-readme

Conversation

Copilot AI commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

README contained inaccurate/incomplete information about Nautobot compatibility, the demo environment, and the test suite.

Changes

  • Fix ASN documentation — removed incorrect claim that ASNs require ipam/asns + Nautobot 2.x+; in Nautobot 3.x core that endpoint is BGP-plugin-only and ASN lives as an integer field on the Location model
  • Add Nautobot Version Compatibility table — explicit 2.x vs 3.x breakdown covering GPS, device list, ASN source, and nested object behaviour (brief id+url objects in 3.x)
  • Add Demo section — documents demo/docker-compose.yml one-liner for a fully self-contained demo with mock Nautobot; no live instance required
  • Expand Running Tests — describes all three test layers (unit, mock-integration, live integration) and links to development/README.md for the real Nautobot 3.x stack
  • Fix requirements wording — "v3.x recommended" → "v2.x or v3.x" to reflect actual compatibility
  • Fix demo location count — parenthetical now correctly reflects 8 locations (two in Copenhagen)
Original prompt

Update readme


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

…, test descriptions

Co-authored-by: Jackass4life <94110786+Jackass4life@users.noreply.github.com>
Agent-Logs-Url: https://github.com/Jackass4life/Nautobot-maps/sessions/78a67d8b-96b1-4ff0-983f-deb5e2238560
Copilot AI changed the title [WIP] Update README file with latest information Update README with demo section, version compatibility table, and accurate ASN notes Mar 23, 2026
Copilot AI requested a review from Jackass4life March 23, 2026 16:38
@Jackass4life
Jackass4life marked this pull request as ready for review March 23, 2026 17:49
@Jackass4life
Jackass4life merged commit 69af1c3 into main Mar 23, 2026
3 checks passed
@Jackass4life
Jackass4life deleted the copilot/update-readme branch March 24, 2026 07:38
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.

2 participants