Skip to content

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Feb 6, 2026

Pull Request Description

What and why?

Let's get our custom integrations docs out on prod.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

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 and others added 30 commits December 16, 2025 08:30
* Edit: Manage users

* Edit training
* Edit: Export documents

* Footnotes & cleanup
* Move callout for lazy readers, minor edit

* Initial topic updates

* Move shared file to match our de facto convention, fix typo, add margin links

* Break filter content out into its own topic

* Experiment with buttons

* Edits, edits, edits

* Add more imbed examples for the review

* Lots more edits

* Edits

* Edits

* Text edits

* Minor text tweaks

* Formatting tweaks

* Add .callout-button styles

* Fix active/inactive tabset text colors

* Split steps in examples

* Attempt a fix at transparency issue in callouts

* Formatting tweaks

* Remove YAML header

* Address review feedback

* Add wrapper topic for help links from the UI

* Move select your filters files into shared/ folder

* Style + instruction edits

* Undo file rename & move images

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
* Select your filters > Work with filters

* Replace
* Preview for 26.01 release notes

* Update .github/workflows/validate-docs-site.yaml
* Initial set of docs changes for improved attestation process

* Updated task topics and edits

* Minor edits

* Improve owner + group explanations

* Remove column experiment

* Edits

* Update prerequisites

* Add animated GIF

* Embed animated GIF in overview topic & tweak mermaid diagram

* Add collapsible section, hint about group filtering
* Initial content generation experiment

* Content hacking

* More edits

* Edits

* Edits

* Minor edits

* Put use cases under umbrella categories

* Consistency edits, content improvements

* Update home page & edits

* Fix børked links

* Simplify title

* Change links to margin footnotes, other formatting fixes

* Massaging text for .tour-bg

* AI governance local edits

* EU AI Act edits

* Model risk management edits

* Library and platform edits

* Use case compliance include

* SR 11-7 edit

* SS1/23 edit

* E-23 edit

* Training: Consistency & subtitle card edits

* Training: Minor styling edit

* Update site/about/use-cases/model-risk-management.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Rename topic to match short title

* Remove latinisms

* Update site/about/overview.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Update site/about/use-cases/ai-governance.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Update site/about/use-cases/ai-governance.qmd

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

* Address review comments

* Minor addition to E-23 guide

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
github-actions bot and others added 26 commits January 29, 2026 21:23
* User Action v2 mulitple steps setup

* Updating example image

* Using VM for Model Risk Management > Risk Management

* oops

* Updated example as per Rod's suggestion
* Add initial AWS Marketplace docs

* Add 26.02 release notes branch

* Run make get-source

* Add excluded categories for latest features on home page

* Apply suggestion from @nrichers
* Block staging site from search engine indexing

Add robots.txt and noindex meta tags to prevent docs-staging.validmind.ai
from being indexed by search engines.

[sc-14355]

* Block development/PR preview environment from search engine indexing

Add noindex meta tag and robots.txt to PR preview deployments.

[sc-14355]
* Cleanup: Working with model documentation

* Cleanup: Working with model documentation subtopics

* Cleanup: Preparing validation reports & subtopics

* Cleanup: Manage model documents

* Wording adjust

* Edit
* Initial draft

* Save point

* More complete custom integrations content

* Add better example info
Fix merge conflicts between staging and prod
@nrichers nrichers added the internal Not to be externalized in the release notes label Feb 6, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

PR Summary

This PR introduces significant enhancements to the project documentation. The changes focus on:

  1. Adding a new skill document titled create-user-documentation. This document details a workflow for gathering context from various sources (like Shortcut, PRs, and demos) and provides guidance on choosing the appropriate documentation template. It also outlines the style guidelines and file structure requirements for generating valid documentation pages.

  2. Updating the sidebar navigation for the guide section. The changes modify the listed integrations by removing the old linking page and adding the new custom integrations page along with a renamed linking page. This ensures that navigation reflects the newly introduced documentation pages.

  3. Expanding the integrations documentation:

    • In the configure-connections.qmd file, a new section for "Custom" integrations is added. This section explains how to configure user-defined connections, laying out details such as endpoint URLs, API keys, and integration types.
    • A new page, implement-custom-integrations.qmd, has been added. This page gives comprehensive guidance on building custom integrations using the reference API, including the required endpoints, authentication methods, and bidirectional synchronization details. It also includes practical examples, best practices, and instructions for adding and linking custom integrations via the UI.
  4. Minor alias updates in the linking documentation to ensure backward compatibility and proper redirection.

Overall, these changes aim to ensure that both internal and external users have clear, comprehensive, and consistent guidance on documentation processes and integrating custom services.

Test Suggestions

  • Verify that all new documentation pages render correctly in the documentation site and that the YAML headers comply with the required format.
  • Check that the navigation sidebar reflects the updated file names and aliases, ensuring all links and aliases resolve properly.
  • Review the markdown for proper formatting of callouts, code blocks, and tables, especially in the new custom integrations documentation.
  • Test the example API endpoints and code snippets in the custom integrations page to ensure they provide clear and accurate guidance.
  • Run a spell check and consistency check against the style guide to ensure adherence to the ValidMind style conventions.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

Validate docs site

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

@nrichers nrichers merged commit 6f3e0dc into prod Feb 6, 2026
10 of 11 checks passed
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.

4 participants