HTTP proxy guide for ValidMind Library

[nrichers]

Pull Request Description

What and why?

This change adds a developer guide, Use an HTTP proxy with the ValidMind Library, that explains how to route outbound HTTPS traffic through a corporate or regional proxy when using the Python library.

The ValidMind library does not expose a proxy argument on vm.init(); the page documents the standard HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and NO_PROXY environment variables, when to restart kernels after changes, how this interacts with other outbound calls (for example LLM SDKs), and troubleshooting steps.

How to test

Try the live preview: Use an HTTP proxy with the ValidMind Library — Allow time for the PR preview deploy with the latest edits to finish

What needs special review?

None.

Dependencies, breaking changes, and deployment notes

None.

Release notes

Documentation: added a guide for using HTTP proxy environment variables with the ValidMind Library. Learn more …

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)

[github-actions]

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

[nibalizer]

lgtm - add a link to this ssl helper docs: b/site/support/troubleshooting.qmd

[github-actions]

PR Summary

This PR enhances the developer documentation for the ValidMind Library by adding guidance on configuring and using an HTTP proxy. The main changes include:

1. An update to the sidebar navigation (site/developer/_sidebar.yaml) where a new entry, "Use an HTTP proxy with the library," has been added to the list of documentation topics.

2. A new documentation file (site/developer/model-documentation/use-http-proxy-with-validmind-library.qmd) that details how to configure proxy-related environment variables (HTTP_PROXY, HTTPS_PROXY, ALL_PROXY, and NO_PROXY) to allow the library to function properly in environments with corporate or regional proxy requirements. The document also provides context, prerequisites, step-by-step instructions, examples (including bash snippets), and troubleshooting tips.

3. A small update in the troubleshooting documentation (site/support/troubleshooting.qmd) that adjusts the header for the SSL verification errors section to include an anchor for better linking.

These changes aim to help developers properly configure and troubleshoot proxy settings when using the ValidMind Library, thereby enhancing usability in restricted network environments.

Test Suggestions

• Manually verify that the new sidebar entry appears correctly and links to the HTTP proxy documentation page.
• Review the new documentation page for clarity and accuracy. Confirm that the instructions are complete and easy to follow.
• Test the instructions by configuring environment variables in a development or staging environment and ensuring that outbound HTTPS requests via the proxy work as expected.
• Click on the adjusted SSL verification error link in the troubleshooting page to confirm that the anchor works correctly.

[github-actions]

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: e33ea5a

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.82
/get-started/get-started.html	0.85	0.74	1.00	0.73
/guide/guides.html	0.85	0.69	1.00	0.82
/index.html	0.93	0.62	1.00	0.82
/releases/all-releases.html	0.86	0.68	1.00	0.73
/support/support.html	0.91	0.67	1.00	0.82
/training/training.html	0.85	0.63	0.96	0.73

[github-actions]

Validate docs site

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