This repository contains the source files for ValidMind's documentation site.
For an overview of the documentation structure and how to navigate it, see:
This page explains:
- How the documentation is organized
- What each section covers
- Where to find guides, API references, and training materials
| Section | Path | Purpose |
|---|---|---|
| About | /site/about/ |
Platform overview, use cases, deployment options |
| Get started | /site/get-started/ |
Role-based quickstarts |
| Guides | /site/guide/ |
Step-by-step instructions for platform tasks |
| Developer | /site/developer/ |
ValidMind Library, code samples, API reference |
| Training | /site/training/ |
Courses and learning paths |
| Support | /site/support/ |
Help resources and troubleshooting |
If you are an AI agent embedded in ValidMind, your capabilities are documented here:
This page describes what the assistant can and cannot do, including context-aware features and current limitations.
The in-app assistant (Valerie) also ingests chatbot-product-map.md in the LLM corpus. That file maps platform routes (for example /settings/workflows, /model-inventory, /dashboard) to documentation URLs and section hints.
Route and help-link data from the product UI is vendored as site/llm/chatbot-product-map-frontend-snapshot.json. Regenerate it with make -C site refresh-chatbot-product-map when frontend routes or helpLink values change (requires a local validmind/frontend checkout).
Use the map when the user’s question is tied to where they are in the product — especially Settings, where the UI groups features differently than the documentation sidebars (Configuration, Workflows, Inventory, and so on).
For documentation organized by topic, continue to use Using the documentation (above) and the section table in this file.
Documentation is written in Quarto Markdown (.qmd). Key conventions:
- Variables use
{{< var name >}}syntax (defined in_variables.yml) - Cross-references use relative paths ending in
.qmd - Images are stored alongside their
.qmdfiles