feat: add help cards in /help, based on configurable supportEmail

[omkar-ethz]

Description

This PR adds an environment variable supportEmail. If set, a card "Questions or issues" is added in the /help page like so:

Motivation

Currently, users had no way to look up a contact email in case of issues or questions. This PR adds it via a configurable supportEmail env var.

Fixes:

None

Changes:

Please provide a list of the changes implemented by this PR

• add supportEmail in appConfig
• add a card in /help component

Tests included

• Included for each change/fix?
• Passing? (Merge will not be approved unless this is checked)

Documentation

• swagger documentation updated [required]
• official documentation updated [nice-to-have]

official documentation info

N/A

Backend version

• Does it require a specific version of the backend
• which version of the backend is required:

Summary by Sourcery

Add supportEmail configuration and display contextual help cards in the UI

New Features:

• Introduce supportEmail environment variable in AppConfig
• Render a “Questions or issues?” card on the /help page when supportEmail is set
• Render a “Getting help” card on the /about page for PSI facility with optional contact email

[sourcery-ai]

Hey @omkar-ethz - I've reviewed your changes - here's some feedback:

• Consider extracting the support contact card into a shared component instead of duplicating the HTML and logic in both Help and About.
• Replace the raw "PSI" string check with a constant or enum to avoid typos and improve maintainability when gating the About card.
• You can remove the wrapping

  tag around the mat-card in help.component.html and apply the *ngIf directly on the mat-card to keep the DOM structure cleaner.

Prompt for AI Agents

Please address the comments from this code review:
## Overall Comments
- Consider extracting the support contact card into a shared component instead of duplicating the HTML and logic in both Help and About.
- Replace the raw "PSI" string check with a constant or enum to avoid typos and improve maintainability when gating the About card.
- You can remove the wrapping <p> tag around the mat-card in help.component.html and apply the *ngIf directly on the mat-card to keep the DOM structure cleaner.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[minottic]

what's the idea behind having the email in both places? We should remember to document this once this (reviewed and improved) is in this repo's readme/docs

[omkar-ethz]

what's the idea behind having the email in both places? We should remember to document this once this (reviewed and improved) is in this repo's readme/docs

this was based on Leo's suggestion (that user's might also want to see the support email in about). But i agree the Help page is pretty easy to find, so fine with removing the card from About.

[omkar-ethz]

what's the idea behind having the email in both places? We should remember to document this once this (reviewed and improved) is in this repo's readme/docs

this was based on Leo's suggestion (that user's might also want to see the support email in about). But i agree the Help page is pretty easy to find, so fine with removing the card from About.

I will also create a PR in the current version of the docs once we decide the behavior of supportEmail (whether we keep the card in About or not) - so that when the docs are moved to this repo, this gets included as well.

[minottic]

this was based on Leo's suggestion (that user's might also want to see the support email in about). But i agree the Help page is pretty easy to find, so fine with removing the card from About.

thx. I also think the /help is enough

[omkar-ethz]

this was based on Leo's suggestion (that user's might also want to see the support email in about). But i agree the Help page is pretty easy to find, so fine with removing the card from About.

thx. I also think the /help is enough

Removed the card in /about. Created a PR in docs: SciCatProject/documentation#81 - unfortunately i don't have permissions to add reviewers or merge. Once this PR is merged, will create a PR in scicat-ci's version of frontend.

[minottic]

thx!