doc: itk dashboard documentation#549
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive technical guide for the A2A ITK Compatibility Dashboard, detailing its usage, data pipeline architecture, and contribution process. It also adds a 'Docs' link to the dashboard header with corresponding CSS styling. Review feedback suggests enhancing security by adding 'rel="noopener noreferrer"' to external links, using relative paths for internal repository references to improve portability, and ensuring version naming consistency within the documentation.
| <h1>A2A SDKs Compatibility</h1> | ||
| <h1> | ||
| A2A SDKs Compatibility | ||
| <a href="https://github.com/a2aproject/a2a-samples/blob/main/itk-dashboard/doc/README.md" target="_blank" class="doc-link" title="View Architecture & Interpretation Guide">Docs</a> |
There was a problem hiding this comment.
When using target="_blank", it is a security best practice to include rel="noopener noreferrer" to prevent the opened page from potentially accessing the original window object via window.opener.
| <a href="https://github.com/a2aproject/a2a-samples/blob/main/itk-dashboard/doc/README.md" target="_blank" class="doc-link" title="View Architecture & Interpretation Guide">Docs</a> | |
| <a href="https://github.com/a2aproject/a2a-samples/blob/main/itk-dashboard/doc/README.md" target="_blank" rel="noopener noreferrer" class="doc-link" title="View Architecture & Interpretation Guide">Docs</a> |
| ### 3. Node Versioning | ||
| Inside the node rectangles in the topology graph: | ||
| * **`current`**: Corresponds to the latest development version built from the `main` branch of the SDK repository. | ||
| * **Tagged Versions (e.g., `python_v10`, `go_v03`)**: Corresponds to released historical versions of the SDKs. |
There was a problem hiding this comment.
For consistency with the examples used elsewhere in the documentation (like go_v03 on line 39) and the actual project structure, consider using python_v03 instead of python_v10.
| * **Core Test Kit Runner & Mock Server**: [Core Test Kit](https://github.com/a2aproject/a2a-samples/tree/main/standalone-itk/itk/) | ||
| * Contains the central test runner, HTTP mock notification server, and scenario definitions. | ||
| * **Go SDK ITK Implementation**: [Go SDK Suite](https://github.com/a2aproject/a2a-samples/tree/main/standalone-itk-go/itk/) | ||
| * Code for verifying Go SDK interoperability. | ||
| * **Dashboard Code**: [Dashboard Code](https://github.com/a2aproject/a2a-samples/tree/main/itk-dashboard/) | ||
| * Static index page, stylesheets, and rendering scripts. | ||
|
|
||
| ### How to Contribute | ||
| * **Adding a New Scenario**: Modify the scenario array inside [scenarios.json](https://github.com/a2aproject/a2a-samples/blob/main/standalone-itk/itk/scenarios.json). | ||
| * **Implementing a New SDK Launcher**: Read the [ITK Testing Framework Guide](https://github.com/a2aproject/a2a-samples/blob/main/standalone-itk/itk/README.md) and create a dedicated launcher for the target SDK that respects the isolation and mock notification standards. |
There was a problem hiding this comment.
Consider using relative links (e.g., ../../standalone-itk/itk/) instead of absolute GitHub URLs for internal repository references. This makes the documentation more portable across forks and branches.
1c214c7 to
7c0ccd7
Compare
Description
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
CONTRIBUTINGGuide.Fixes #<issue_number_goes_here> 🦕