Skip to content

Move docs from baselibs_rust into baselibs and score (follow-up to #200) #243

Description

@4og

What

Issue #200 covers the full migration of eclipse-score/baselibs_rust into eclipse-score/baselibs, including source code, build files, and CI. This follow-up task covers the documentation part of that migration: moving the filled documentation from baselibs_rust/docs/ into the existing baselibs/docs/ structure so that all platform documentation lives in one place, consistent with the consolidated repository.

Acceptance Criteria (DoD)

  • The feature-level requirements from baselibs_rust/docs/features/ are moved to https://github.com/eclipse-score/score/tree/main/docs/features/baselibs. Check the difference and move only the ones that exist in baselibs_rust (ask @aschemmel-tech fore review).
  • The filled component docs from baselibs_rust/docs/baselibs_rust/log/ (architecture, requirements, detailed design, and component index) are moved into baselibs/docs/baselibs/components/log_frontend/. Files that contain only unfilled template placeholders are excluded.
  • The filled component docs from baselibs_rust/docs/baselibs_rust/containers_rust/ (architecture, requirements) are moved into baselibs/docs/baselibs/components/containers_rust/. Files containing unfilled template sections are excluded.
  • All internal cross-references and toctree entries in the moved files are updated to reflect their new paths within baselibs/docs/.
  • The baselibs Sphinx build completes without errors or broken-reference warnings for the newly added files.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

Fields

No fields configured for Task.

Projects

Status
Done
Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions