Skip to content

Conversation

@gopu0106
Copy link

@gopu0106 gopu0106 commented Jan 4, 2026

This PR addresses issue #222 by adding a dedicated tutorial explaining how to create a WireGuard topology template in OpenWISP and visualize it using the Network Topology module.

Changes

  • Added a new tutorial: tutorials/wireguard-topology.rst
  • Registered the tutorial in tutorials/index.rst

Notes

  • Documentation follows existing OpenWISP style and structure
  • NetJSON examples and variables align with current OpenWISP standards
  • No unrelated files were modified

@coderabbitai
Copy link

coderabbitai bot commented Jan 4, 2026

Walkthrough

A new tutorial document, "WireGuard Topology", was added to the tutorials directory and included in the tutorials index toctree. The tutorial describes prerequisites and step-by-step UI instructions to create a WireGuard configuration template (including an example JSON for wg0), enable topology visualization, assign the template to devices, and verify the topology with wg show and the Network Topology dashboard. No code, exported/public declarations, or runtime control flow were changed.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Pre-merge checks

✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title '[docs] Add WireGuard topology tutorial' directly and clearly summarizes the main change: adding a new documentation tutorial about WireGuard topology.
Description check ✅ Passed The description is directly related to the changeset, explaining that it adds a WireGuard topology tutorial to address issue #222 and listing the specific files modified.

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fba8d74 and b5b9431.

📒 Files selected for processing (1)
  • tutorials/wireguard-topology.rst
🚧 Files skipped from review as they are similar to previous changes (1)
  • tutorials/wireguard-topology.rst

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

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 32d3eaf and e8fe317.

📒 Files selected for processing (2)
  • tutorials/index.rst
  • tutorials/wireguard-topology.rst
🧰 Additional context used
🪛 GitHub Actions: OpenWISP Docs
tutorials/wireguard-topology.rst

[error] 1-1: ReStructuredText formatting check failed during PRODUCTION=1 ./run-qa-checks. File could be reformatted.

🔇 Additional comments (2)
tutorials/index.rst (1)

12-12: toctree entry correctly added.

The tutorial reference is properly registered in the documentation navigation with consistent formatting.

tutorials/wireguard-topology.rst (1)

1-102: No critical RST formatting issues found; cross-references follow established patterns in the codebase.

The RST syntax is valid with properly formatted title underlines, code blocks, and cross-reference directives. The cross-reference pattern (:doc:/controller/user/wireguard``, etc.) is standard throughout this documentation, used identically in tutorials/hotspot.rst, `tutorials/mesh.rst`, `tutorials/wifi-access-point.rst`, and other tutorials. These module-level paths are dynamically built as part of the multi-version documentation process defined in `build.py`, not local files.

Likely an incorrect or invalid review comment.

@gopu0106
Copy link
Author

gopu0106 commented Jan 4, 2026

Thanks for taking a look.

This PR addresses issue #222 by adding a dedicated tutorial that explains how to create a WireGuard topology in OpenWISP. The changes are intentionally kept small and focused , it only adds the new tutorial page and registers it in the tutorials index.

No existing documentation or behaviour was changed beyond that.
I’m happy to update or refine anything if there’s feedback from the reviewers.

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