Repository navigation
docs(ARCHITECTURE): Update Ardchitecture documentation - #2410
Merged
Merged
Conversation
Signed-off-by: Dr.-Ing. Amilcar do Carmo Lucas <amilcar.lucas@iav.de>
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The workflow documentation omits the required session restart after flashing, leaving users unaware that successful reconnection does not return them to configuration in the existing session.
1 open issue
What changed in this PR
Refreshes the architecture guide to describe ArduPilot Methodic Configurator’s application structure and developer entry points. Changes are documentation-only; runtime behavior is unchanged.
Changes:
- Clarifies the startup workflow and on-demand firmware upload.
- Documents parameter-editor tools, plugins, and standalone entry points.
- Removes the V-model overview and updates testing guidance to reference pytest.
| File | Description |
|---|---|
ardupilot_methodic_configurator/__main__.py |
Updates the module docstring to include on-demand firmware upload. |
ARCHITECTURE.md |
Revises workflow descriptions, tool and plugin inventories, entry points, and testing guidance. |
Review effort: Balanced
Comment on lines
+73
to
+74
| 6. **[Firmware Upload](ARCHITECTURE_firmware_upload.md)** - Flashes an ArduPilot APJ firmware image through the bootloader | ||
| and reconnects to the flight controller. It is opened on demand from the project opener (sub-application 3) |
Contributor
☂️ Code Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Description
Update Ardchitecture documentation
Checklist
git commit --signoff)Testing
Describe how you tested these changes: