Skip to content

[docs] Moved architecture diagrams to developer documentation - #1463

Merged
nemesifier merged 1 commit into
masterfrom
move-architecture-callouts
Aug 27, 2026
Merged

[docs] Moved architecture diagrams to developer documentation#1463
nemesifier merged 1 commit into
masterfrom
move-architecture-callouts

Conversation

@nemesifier

@nemesifier nemesifier commented Aug 27, 2026

Copy link
Copy Markdown
Member

Checklist

Reference to Existing Issue

N/A

Description of Changes

Moves the OpenWISP architecture callout from the module landing page to the first developer documentation page.

Screenshot

N/A

@nemesifier nemesifier added the docs Related to documentation label Aug 27, 2026
@nemesifier nemesifier self-assigned this Aug 27, 2026
@kilo-code-bot

kilo-code-bot Bot commented Aug 27, 2026

Copy link
Copy Markdown

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (2 files)
  • docs/developer/installation.rst
  • docs/index.rst

Reviewed by balanced · Input: 42.1K · Output: 5.1K · Cached: 134.1K

@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 8075ca2c-ef77-4191-8ddb-08abb9b07969

📥 Commits

Reviewing files that changed from the base of the PR and between 0b1014f and d24ffa2.

📒 Files selected for processing (2)
  • docs/developer/installation.rst
  • docs/index.rst
💤 Files with no reviewable changes (1)
  • docs/index.rst

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.

📜 Recent review details
⏰ Context from checks skipped due to timeout. (12)
  • GitHub Check: auto-assign-issue / run-bot
  • GitHub Check: Python==3.10 | django~=5.1.0
  • GitHub Check: Python==3.12 | django~=4.2.0
  • GitHub Check: Python==3.13 | django~=5.1.0
  • GitHub Check: Python==3.11 | django~=5.2.0
  • GitHub Check: Python==3.13 | django~=5.2.0
  • GitHub Check: Python==3.12 | django~=5.1.0
  • GitHub Check: Python==3.12 | django~=5.2.0
  • GitHub Check: Python==3.11 | django~=4.2.0
  • GitHub Check: Python==3.11 | django~=5.1.0
  • GitHub Check: Python==3.10 | django~=4.2.0
  • GitHub Check: Python==3.10 | django~=5.2.0
🧰 Additional context used
📓 Path-based instructions (2)
Verify that documentation remains consistent with the implemented

⚙️ CodeRabbit configuration file

Files:

  • docs/developer/installation.rst
- Flag potential security vulnerabilities

⚙️ CodeRabbit configuration file

Files:

  • docs/developer/installation.rst
🔇 Additional comments (1)
docs/developer/installation.rst (1)

6-21: LGTM!


📝 Walkthrough

Walkthrough

The installation guide now includes the Controller architecture diagram and a note about viewing the image and related architecture documentation. The Controller documentation index no longer includes this diagram or its related text.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to d24ff

This documentation-only change moves the architecture callout without introducing a concrete product or production risk; no actionable merge-blocking risk remains.


Caution

Pre-merge checks failed

Please resolve all errors before merging. Addressing warnings is optional.

  • Ignore

❌ Failed checks (1 error)

Check name Status Explanation Resolution
Ui Changes, Regression Test, Docs ❌ Error The patch changes the rendered documentation UI. It removes the architecture figure and admonition from docs/index.rst and adds them to docs/developer/installation.rst, so users see different cont… Add before-and-after screenshots or a screen recording to the PR description. Show the architecture callout on the Controller module landing page before the change, and on the Developer Installation page after the change.
✅ Passed checks (4 passed)
Check name Status Explanation
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.
Description check ✅ Passed The description follows the required template. It includes the checklist, issue reference status, change summary, and screenshot status. The content matches the documentation-only changes.
Title check ✅ Passed The title uses the required [docs] prefix and clearly describes moving the architecture diagrams to developer documentation.
Full details: Ui Changes, Regression Test, Docs

Explanation

The patch changes the rendered documentation UI. It removes the architecture figure and admonition from docs/index.rst and adds them to docs/developer/installation.rst, so users see different content on two documentation pages. The PR description marks Screenshot as N/A and includes no before-and-after screenshots or screen recording. The patch changes only documentation, so the application-code regression-test condition does not apply. Documentation was updated as required.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch move-architecture-callouts

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

@coveralls

Copy link
Copy Markdown

Coverage Status

Coverage is 98.358%move-architecture-callouts into master. No base build found for master.

@nemesifier nemesifier changed the title Moved architecture diagrams to developer documentation [docs] Moved architecture diagrams to developer documentation Aug 27, 2026
@nemesifier

Copy link
Copy Markdown
Member Author

@coderabbitai resolve

@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Comments resolved and changes approved.

@nemesifier
nemesifier merged commit e92e099 into master Aug 27, 2026
25 checks passed
@nemesifier
nemesifier deleted the move-architecture-callouts branch August 27, 2026 16:08
@github-project-automation github-project-automation Bot moved this from Backlog to Done in 26.06 Release Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Related to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants