Skip to content

docs: review and fill gaps for v0.4.7 release#307

Merged
bonzo81 merged 1 commit into
developfrom
docs/v0.4.7-review
Jun 5, 2026
Merged

docs: review and fill gaps for v0.4.7 release#307
bonzo81 merged 1 commit into
developfrom
docs/v0.4.7-review

Conversation

@bonzo81

@bonzo81 bonzo81 commented Jun 5, 2026

Copy link
Copy Markdown
Owner

Summary

Reviews and fills gaps in the user documentation ahead of the v0.4.7 release, and brings the root README.md and docs/README.md back into sync. Documentation only — no code changes.

Motivation / Problem

What issue does this solve?

  • Maintenance / cleanup

Ahead of v0.4.7 the docs had several gaps relative to merged features:

Scope of Change

  • Web UI / templates (docs content only)
  • Docs only

How Was This Tested?

  • Unit tests: no — documentation-only change
  • Manual testing: yes — verified all new navigation entries and cross-links resolve to existing files, and compared the feature subsection headings between README.md and docs/README.md for parity

Manual Test Steps (if applicable)

  1. Confirmed docs/usage_tips/module_sync.md, docs/usage_tips/mapping_rules.md, and docs/development/extension_points.md are referenced from both mkdocs.yml and docs/SUMMARY.md.
  2. Verified every linked file/target exists in the repo.
  3. Diffed the ### feature headings of both READMEs to confirm they match.

Note: a full mkdocs build --strict could not be run in this environment (missing include-markdown plugin and no pip), so a strict build is recommended in the normal docs environment as a final check.

Risk Assessment

  • Does this change affect existing users? No — documentation only.
  • Could this cause unintended imports / updates? No.

Backwards Compatibility

  • No breaking changes

Other Notes

  • New page: docs/development/extension_points.md documenting the predict_module_interface_names signal and the VC normalization report.
  • Navigation updated in both mkdocs.yml and docs/SUMMARY.md.
  • The version bump and 0.4.7 changelog entry are intentionally not included here and can be done as part of the release step.

- Add Module Sync and Mapping Rules to mkdocs and SUMMARY navigation
- Document the opt-in "Set Primary IP" toggle on IP Address Sync (#303)
- Add developer Extension Points page for the
  predict_module_interface_names signal and VC normalization report (#298)
- Note module-interface adoption in the Module Sync guide (#296)
- Sync root README and docs README feature sections (Module/Inventory
  Sync, hardware-model filter, Platform Mappings link, multi-server)
@coderabbitai

coderabbitai Bot commented Jun 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5412ff2f-6b18-43a3-9b22-f5580473292a

📥 Commits

Reviewing files that changed from the base of the PR and between 09afc89 and b324e3a.

📒 Files selected for processing (8)
  • README.md
  • docs/README.md
  • docs/SUMMARY.md
  • docs/development/README.md
  • docs/development/extension_points.md
  • docs/feature_list.md
  • docs/usage_tips/module_sync.md
  • mkdocs.yml

Walkthrough

This pull request updates plugin documentation across eight files. The primary changes introduce user-facing descriptions for sync feature enhancements (Device Import hardware filtering, Module/Inventory Sync, Device Field Sync with platform mappings, IP Address Sync with optional Set Primary IP toggle, and Multi LibreNMS Server Configuration), along with new developer documentation for the predict_module_interface_names extension signal contract. A technical guide explains module interface template reconciliation during installation, and navigation updates in MkDocs configuration and SUMMARY index the new documentation pages.

Possibly related PRs

  • bonzo81/netbox-librenms-plugin#298: The extension points and module interfaces documentation in this PR directly describes the predict_module_interface_names signal contract introduced in that PR.
  • bonzo81/netbox-librenms-plugin#288: Both PRs update overlapping documentation sections around Module/Inventory Sync and Device Field Sync, including references to platform mappings and mapping rules guides.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change—a documentation review and gap-filling for the v0.4.7 release.
Description check ✅ Passed The pull request description comprehensively covers all template sections: Summary, Motivation/Problem, Scope of Change, How Was This Tested (with manual test steps), Risk Assessment, Backwards Compatibility, and Other Notes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@bonzo81 bonzo81 merged commit e6def35 into develop Jun 5, 2026
9 checks passed
@bonzo81 bonzo81 deleted the docs/v0.4.7-review branch June 5, 2026 14:50
@bonzo81 bonzo81 mentioned this pull request Jun 5, 2026
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.

1 participant