Skip to content

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Jan 13, 2026

Pull Request Description

What and why?

sc-7858

We have a mix of references to our support email and support URL in the docs site, sometimes using .ai and sometimes .com. Standardised the usage with two new variables that reference:

How to test

You can pull down the PR and add the variables anywhere and preview and it will show up as expected, with the exception(s) labelled under "What needs special review?"

What needs special review?

Exceptions

Variable exception

Any URLs in listing paths CANNOT be a variable, as this breaks the link. For example:

- path: https://support.validmind.com

Mailto exception

Apparently, variables also don't work with <email@domain.com>, so those have been changed to markdown mailto links.

General note

Note

We have other instances of validmind.ai hanging out, but I choose to go .com with the support as our main website resolves from .ai to .com. For some reason, docs.validmind.ai is the exception.

Dependencies, breaking changes, and deployment notes

I noticed the support centre needs you to be logged in now — not sure if that was a change that was made deliberately (probably) but it feels like that changes how the messaging around it is phrased.

Release notes

n/a

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@validbeck validbeck self-assigned this Jan 13, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label Jan 13, 2026
@validbeck validbeck requested a review from nrichers January 13, 2026 20:48
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

Good change, my only request is that we keep the existing long form and short form sections clean. Please move the new variables into their own section for support.

@github-actions
Copy link
Contributor

PR Summary

This PR introduces dynamic support URL configurations into the project's documentation. A new section for support URLs has been added to the _variables.yml file, allowing the support center and email values to be configured as variables. Additionally, markdown files for AWS, Azure, and Google configuration have been updated to reference these new support variables instead of hard-coded email addresses and URLs. This change ensures consistency across the documentation and simplifies future updates by centralizing support URL management.

Test Suggestions

  • Verify that the support URLs render correctly in the documentation pages when the variables are substituted.
  • Check that hyperlinks for support email and support center in AWS, Azure, and Google configurations navigate to the correct destinations.
  • Ensure that the updated variables in _variables.yml are correctly propagated across all related documentation pages.
  • Perform a visual inspection of the rendered pages to confirm that formatting is not adversely affected by these changes.

@github-actions
Copy link
Contributor

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: 5e789cc

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.67 1.00 0.90
/get-started/get-started.html 0.85 0.69 1.00 0.80
/guide/guides.html 0.85 0.67 1.00 0.90
/index.html 0.93 0.61 1.00 0.90
/releases/all-releases.html 0.86 0.64 1.00 0.80
/support/support.html 0.91 0.66 1.00 0.90
/training/training.html 0.85 0.62 0.96 0.80

@github-actions
Copy link
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@validbeck validbeck requested a review from nrichers January 14, 2026 19:43
@validbeck
Copy link
Collaborator Author

@nrichers Good call, was wondering what I should do with those variables but your suggestion makes sense. I've updated them, please refer to the edited PR description for more details: #1112 (comment)

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM! 🚀

@validbeck validbeck merged commit 02a6dbd into main Jan 15, 2026
6 checks passed
@validbeck validbeck deleted the beck/sc-7858/standardize-support-email-and-url-in-docs branch January 15, 2026 02:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants