Skip to content

Conversation

akoerner1
Copy link
Contributor

@akoerner1 akoerner1 commented Sep 3, 2025

Major housekeeping, documentation overhaul, and quality of life improvements

This PR delivers comprehensive repository maintenance, documentation updates, and
various bug fixes and enhancements across ADORe.

Documentation

  • Added extensive help documents to the technical reference manual
  • Fixed all dead links in the technical reference manual
  • Updated pull request template

Eclipse Due Diligence & Compliance

  • Added required documentation: THIRD-PARTY.md, CONTRIBUTING.md, NOTICES.md, SECURITY.md
  • Documented all third-party assets in THIRD-PARTY.md
  • Removed DLR logo and background image for neutrality and IP compliance
  • Normalized source documentation headers across the repository
  • Added due_diligence_scan and due_diligence_fix make targets to scan for compliance headers
  • Added citation.cff for proper attribution

Build System & CLI Enhancements

  • Fixed bug requiring empty header-only/interface libraries in ADORe library generation
  • Enhanced ADORe CLI with base image support and GitHub repository integration for faster builds
    (See full details: Refactor/ros2 major refactor adore_cli#1)
  • Added configuration parameters to adore.env for ADORe CLI behavior customization
  • Updated all .gitmodule URI references from dlr-ts to eclipse-adore

ROS2 Workspace

  • Added ros2_workspace/tools/ros2_debian_packager.sh for packaging nodes as Debian archives
    Usage: make cli && cd ros2_workspace && make package
    Output: Debian archives in the ros build directory for each node

…ug, added more readme docs to the user libraries including a help guide for creating a new library.
…re system, added guides for creating nodes, added check_adore_binaries.sh to check/verify that libraires are built, update hello world node

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
…roject and added missing documentiaon to fill documentation holes.

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
- update util.mk to improve the package target to use a dynamic parent directory
- Massive rework to the technical reference manual.
- IP due diligence scan of the repo, added CONTRIBUTERS.md, THIRD-PARTY.md
- added 'make due_diligence_scan' and 'make due_diligence_fix' targets to scan and fix license headers
- Added check_adore_binaries.sh to warn user if the user library or ros2 node binaries have not been built. Auto-invoked with make cli
- Normalized eclipse doc headers on all source files
- Added unit test for x11 display
- fixed some small semantic bugs in the api
- updated the ADORe CLI

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
…rors in the documentation, updated the aspell dictionary, updated CONTRIBUTERS.md and THIRD-PARTY.md and added SECURITY.md

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
…erence manual

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
…ated css, js and html, removed dlr logo, updated vendor hashes

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
…verall project layout

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
…ly in github actions

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
…or package

Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
Signed-off-by: Andrew Koerner <andrew.koerner@dlr.de>
@akoerner1 akoerner1 requested a review from n-mat September 30, 2025 12:52
@akoerner1 akoerner1 marked this pull request as ready for review September 30, 2025 12:53
Copy link
Contributor

@n-mat n-mat left a comment

Choose a reason for hiding this comment

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

this PR adds documentation, non breaking.

@n-mat n-mat merged commit 7dad77a into develop Sep 30, 2025
8 checks passed
@n-mat n-mat deleted the feature/documentation_improvements branch September 30, 2025 13:32
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