Skip to content

Koma task safety reports integration#465

Open
Komal362000 wants to merge 7 commits into
eclipse-score:mainfrom
Komal362000:koma_task_safety_reports_integration
Open

Koma task safety reports integration#465
Komal362000 wants to merge 7 commits into
eclipse-score:mainfrom
Komal362000:koma_task_safety_reports_integration

Conversation

@Komal362000
Copy link
Copy Markdown
Contributor

@Komal362000 Komal362000 commented May 21, 2026

Problem:
Clicking safety report links opened a standalone HTML page, losing all Sphinx navigation.

Solution:
Added a dedicated RST page per report so they appear as proper Sphinx pages with full navigation. This is a Sphinx requirement — every left sidebar entry must have its own RST file.

Why not auto-generate?
Auto-generation only makes sense when there is real logic involved (e.g. parsing 100+ C++ items). Here each file is just a title + one iframe — writing a Bazel rule for that adds more complexity than it saves.

Files changed:

File | What changed -- | -- BUILD | Added 2 new RST files to sphinx sources safety_reports.rst | Overview table with links + hidden toctree for left sidebar safety_message_passing.rst | New page showing Message Passing report via iframe safety_mw_com.rst | New page showing MW::COM report via iframe

Result: Left sidebar now shows "Safety Reports → Message Passing / MW::COM", report content only appears after clicking, Sphinx navigation never lost.

Problem: Clicking safety report links opened a standalone HTML page, losing all Sphinx navigation.

Solution:
Added a dedicated RST page per report so they appear as proper Sphinx pages with full navigation. This is a Sphinx requirement — every left sidebar entry must have its own RST file.

Why not auto-generate?
Auto-generation only makes sense when there is real logic involved (e.g. parsing 100+ C++ items). Here each file is just a title + one iframe — writing a Bazel rule for that adds more complexity than it saves.

Files changed:

BUILD — Added 2 new RST files to sphinx sources
safety_reports.rst — Overview table with links + hidden toctree for left sidebar
safety_message_passing.rst — New page showing Message Passing report via iframe
safety_mw_com.rst — New page showing MW::COM report via iframe

Result: Left sidebar now shows "Safety Reports → Message Passing / MW::COM", report content only appears after clicking, Sphinx navigation never lost.

@Komal362000 Komal362000 force-pushed the koma_task_safety_reports_integration branch 2 times, most recently from a03b9bd to f4f66b5 Compare May 22, 2026 13:44
- Add safety_message_passing.rst and safety_mw_com.rst as Sphinx pages
- Embed external HTML reports via iframe so report is shown directly
- Update safety_reports.rst to use toctree instead of plain HTML links
- Update BUILD to include new RST source files
- Fixes navigation loss when clicking safety report links
@Komal362000 Komal362000 force-pushed the koma_task_safety_reports_integration branch from 7e8cfc7 to b7f51b7 Compare May 29, 2026 07:02
@Komal362000 Komal362000 force-pushed the koma_task_safety_reports_integration branch from b7f51b7 to 863c4eb Compare May 29, 2026 07:27
@Komal362000 Komal362000 marked this pull request as ready for review May 29, 2026 07:39
@AAmbuj
Copy link
Copy Markdown
Contributor

AAmbuj commented Jun 1, 2026

Code written is right but the feature wise i would suggest not Good to go. we not make report inside report. we go inside the report and return back the main page. this is the right approach for my understanding.

@AAmbuj
Copy link
Copy Markdown
Contributor

AAmbuj commented Jun 1, 2026

Take a reference for public API in same doc.

@Komal362000
Copy link
Copy Markdown
Contributor Author

#465 (comment)
Thank you for the feedback, Ambuj.
I understand your concern. The implementation is technically correct, but I agree the current navigation experience is not ideal yet.

My understanding from Jochen guidance was that each Safety Report should open as its own page when clicked. Based on that, I followed the same navigation pattern used in the Public API reference and implemented it in this PR.

After rechecking, I found one issue that still needs improvement: when clicking a Safety Report, the page source/context is not shown as expected compared to the earlier behavior. I will work on this and update the PR accordingly.

Komal362000 and others added 4 commits June 3, 2026 14:22
Each safety report page now uses proper RST sections (h2 headings)
instead of iframes. This generates the 'On this page' right sidebar
automatically, matching the Public API Reference style.

Message Passing sections: Assumed System Requirements, Assumptions of
Use, Feature Requirements, Architectural Design, Dependability Analysis,
Components.

MW::COM sections: Architectural Design, Dependability Analysis,
Components, Units.

Resolves reviewer comment: no longer embeds a report inside a report.
Replace plain text links with one iframe per section so report
content appears directly in the Sphinx page body. The RST section
headings remain, giving the 'On this page' right sidebar entries.
Removed duplicate 'Open full report' link - content is now on-page.

Navigation experience now matches Public API Reference:
- static top bar throughout
- 'On this page' sidebar updates per safety page
- clicking a sidebar entry scrolls to that section inline
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