Ninosaurier/LUNA-Charts
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Evaluate and update documentation of LUNA-Charts #41

New Issue
Open
opened 2026-09-03 11:32:20 +00:00 by Ninosaurier · 1 comment
Ninosaurier commented 2026-09-03 11:32:20 +00:00
Owner
Copy Link
Copy Source

Goal

The entire documentation must be updated. It serves as the single source of truth and acts as a contract that every contributor must comply with.

Description

I found several passages in the text that are outdated. They must be updated to ensure the documentation remains the single source of truth.

To Do

  • Update the ADRs
  • Update the ADM
  • Update other sections of the documentation

Acceptance Criteria

  • No contradictions exist within the text.
  • ADRs are fully updated.
  • ADM is fully updated.
## Goal The entire documentation must be updated. It serves as the single source of truth and acts as a contract that every contributor must comply with. ## Description I found several passages in the text that are outdated. They must be updated to ensure the documentation remains the single source of truth. ## To Do - [ ] Update the ADRs - [ ] Update the ADM - [ ] Update other sections of the documentation ## Acceptance Criteria - No contradictions exist within the text. - ADRs are fully updated. - ADM is fully updated.
Ninosaurier added the Kind/DocumentationPriority/HighStatus/Verified labels 2026-09-03 11:32:20 +00:00
Ninosaurier self-assigned this 2026-09-03 11:32:20 +00:00
Ninosaurier added the Status/Needs Information label 2026-09-06 10:02:12 +00:00
Ninosaurier added Status/Blocked and removed Status/Needs Information labels 2026-09-07 10:10:41 +00:00
Ninosaurier commented 2026-09-07 10:22:42 +00:00
Author
Owner
Copy Link
Copy Source

Status Update:

Following a discussion with a software architect, this issue will be updated. After the release of v0.3.0, we will initiate an Architecture Definition iteration cycle and update the entire ADM documentation. Reasons for the review:

  • Proven Approach: The milestone-based approach has proven to be successful and currently makes the most sense for us.
  • Proof of Concept (PoC): Milestone v0.3.0 includes a Proof of Concept, meaning it will provide new insights and allow us to make key decisions. Consequently, we may need to rethink previous concepts.
  • Documentation Impact: Milestone v0.3.0 will have a significant impact on the overall documentation.
**Status Update**: Following a discussion with a software architect, this issue will be updated. After the release of v0.3.0, **we will initiate an Architecture Definition iteration cycle** and update the entire ADM documentation. Reasons for the review: - **Proven Approach:** The milestone-based approach has proven to be successful and currently makes the most sense for us. - **Proof of Concept (PoC):** Milestone v0.3.0 includes a Proof of Concept, meaning it will provide new insights and allow us to make key decisions. Consequently, we may need to rethink previous concepts. - **Documentation Impact:** Milestone v0.3.0 will have a significant impact on the overall documentation.
Ninosaurier added reference chore/#41-doc-evaluation 2026-09-07 10:22:46 +00:00
Sign in to join this conversation.
chore/#41-doc-evaluation
Branches Tags
Labels
Clear labels
Community/Good First Issue
Suitable for newcomers making their first contribution.
 Community/Question
General questions or discussions without implementation work.
 Kind/Bug
Something is not working correctly.
 Kind/Documentation
Documentation changes or improvements.
 Kind/Enhancement
Improves existing functionality.
 Kind/Feature
Introduces new functionality.
 Kind/Refactoring
Improves internal implementation without changing external behavior.
 Kind/Testing
Related to tests or testing infrastructure.
 Priority/High
High priority.
 Priority/Low
Low priority.
 Priority/Medium
Normal priority.
 Status/Awaiting Release
Fix has been merged into the development branch but not yet released to production/main. Will be closed once included in a release.
 Status/Blocked
Progress is blocked by another dependency or issue.
 Status/Needs Information
More details or steps to reproduce are required from the author before proceeding.
 Status/Needs Review
Waiting for maintainer or reviewer feedback.
 Status/Verified
The issue has been verified and confirmed.
No labels Kind/Documentation Priority/High Status/Blocked Status/Verified
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
sven Ninosaurier (Antonino Provenzano)
No Assignees Ninosaurier
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Ninosaurier/LUNA-Charts#41