Skip to content

ENH: Add Feedback Form & Documentation Links#213

Merged
zdomke merged 10 commits into
mainfrom
zdomke/external-link-buttons
Mar 17, 2026
Merged

ENH: Add Feedback Form & Documentation Links#213
zdomke merged 10 commits into
mainfrom
zdomke/external-link-buttons

Conversation

@zdomke
Copy link
Copy Markdown
Collaborator

@zdomke zdomke commented Oct 20, 2025

Description

Add ways for users to access Trace's documentation and EED Software Application's feedback form. The URLs for these forms can be changed in the config file for Trace: trace/config.json. The key for the URL for the docs page is "documentation_url", and for the feedback form it is "feedback_form_url".

These sites are accessible via buttons above the plot section as well as menu actions in a new "Help" menu. A warning window is opened if the link is not opened correctly. The window shows the URL so users can reference it manually.

Motivation

Users should have an easily accessible way to submit feedback on the application as well as a way of finding help if they have any questions.

Closes #209
Closes #210

Where Has This Been Documented?

https://slaclab.github.io/trace/overview/plot_section/

Screenshots

Screenshot 2025-10-20 at 15 18 54 Screenshot 2025-10-20 at 15 19 02 Screenshot 2025-10-20 at 15 19 47 Screenshot 2025-10-20 at 15 19 56 Screenshot 2025-10-20 at 11 58 31

Pre-merge checklist

  • Code works interactively
  • Code contains descriptive docstrings
  • New/changed functions and methods are covered in the test suite where possible
  • Test suite passes locally
  • Test suite passes on GitHub Actions

@zdomke zdomke force-pushed the zdomke/external-link-buttons branch from 57b5d89 to 6431d7c Compare October 20, 2025 18:51
@zdomke zdomke self-assigned this Oct 20, 2025
@zdomke zdomke added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request feedback General feedback for the application labels Oct 20, 2025
@zdomke zdomke marked this pull request as ready for review October 20, 2025 22:21
@zdomke zdomke requested a review from a team October 20, 2025 22:21
Copy link
Copy Markdown
Collaborator

@YektaY YektaY left a comment

Choose a reason for hiding this comment

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

This looks good. great work

@zdomke zdomke force-pushed the zdomke/external-link-buttons branch from 5a32894 to 7f3eb71 Compare March 17, 2026 17:04
@zdomke zdomke merged commit 502b6ef into main Mar 17, 2026
3 of 6 checks passed
@zdomke zdomke deleted the zdomke/external-link-buttons branch March 17, 2026 17:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request feedback General feedback for the application

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE] - Open Docs Button [FEATURE] - Add Bug Report Button

2 participants