Skip to content

Conversation

@BramDevlaminck-Skyline
Copy link
Member

@BramDevlaminck-Skyline BramDevlaminck-Skyline commented Jan 6, 2026

Update QAction documentation with the changes from DCP261954, RN44420

Also added documentation on how to debug reoccurring SLScripting and SLProtocol crashes and how to pinpoint which element is causing the crashes. From the code we will put a link to this page, which in this PR will also have a SLProtocol section. This should make it easy for customers to get to the right procedure depending on if they have an slscripting or slprotocol crash

Wait with merging this change until the mentioned task/RN are merged.

@BramDevlaminck-Skyline BramDevlaminck-Skyline requested a review from a team as a code owner January 6, 2026 13:05
@SimonV-Skyline SimonV-Skyline self-requested a review January 6, 2026 13:28
@BramDevlaminck-Skyline BramDevlaminck-Skyline changed the title Update QAction documentation Update QAction documentation for RN44420 Jan 6, 2026
@MariekeGO MariekeGO added the waiting Improvements or additions to documentation label Jan 8, 2026
Copy link
Member

@MariekeGO MariekeGO left a comment

Choose a reason for hiding this comment

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

@MariekeGO MariekeGO self-assigned this Jan 8, 2026
Copy link
Member

@LaurensMT LaurensMT left a comment

Choose a reason for hiding this comment

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

There is a typo in the file name: SLScripring instead of SLScripting

@BramDevlaminck-Skyline
Copy link
Member Author

@MariekeGO, as the troubleshooting steps for a reoccurring SLProtocol and reoccurring SLScripting crash are almost identical, I reused the same file, and just referenced that file twice from the toc.yml. I'm not sure if this is something that has been done before, or if you have any objections against this. It would also be OK for me if this is split up, but that would introduce a lot of duplication.

If you have a better alternative that still keeps a good structure without having to duplicate the whole file, that would also be OK

@MariekeGO
Copy link
Member

@MariekeGO, as the troubleshooting steps for a reoccurring SLProtocol and reoccurring SLScripting crash are almost identical, I reused the same file, and just referenced that file twice from the toc.yml. I'm not sure if this is something that has been done before, or if you have any objections against this. It would also be OK for me if this is split up, but that would introduce a lot of duplication.

If you have a better alternative that still keeps a good structure without having to duplicate the whole file, that would also be OK

The same file should never be referenced twice in the toc.yml, as this will cause odd behavior that users may experience as a bug. What we usually do in a case like this is add the information in one place, and then add a cross-reference to that place where appropriate, as duplicate information is indeed to be avoided.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants