diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000000..b1c662e0e7 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,40 @@ +# Agent Guidelines for ValidMind Documentation + +This repository contains the source files for [ValidMind's documentation site](https://docs.validmind.ai). + +## Start here + +For an overview of the documentation structure and how to navigate it, see: + +**[Using the documentation](https://docs.validmind.ai/about/contributing/using-the-documentation.html)** + +This page explains: +- How the documentation is organized +- What each section covers +- Where to find guides, API references, and training materials + +## Documentation sections + +| 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 | + +## In-app assistant + +If you are an AI agent embedded in ValidMind, your capabilities are documented here: + +**[Chatbot capabilities](https://docs.validmind.ai/guide/chatbot-capabilities.html)** + +This page describes what the assistant can and cannot do, including context-aware features and current limitations. + +## File format + +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 `.qmd` files diff --git a/README.md b/README.md index 2c188de20c..8de8105fa5 100644 --- a/README.md +++ b/README.md @@ -218,7 +218,7 @@ When constructing filepaths, including while using [Quarto's Includes](https://q | Correct | Incorrect | |---|---| -| `[Register models in the inventory](/guide/model-inventory/register-models-in-inventory.qmd)` | `[Register models in the inventory](../../register-models-in-inventory.qmd)` | +| `[Register records in the inventory](/guide/inventory/register-records-in-inventory.qmd)` | `[Register records in the inventory](../../register-records-in-inventory.qmd)` | ### Column layouts diff --git a/internal/templates/single-source/_guides-vs-training.qmd b/internal/templates/single-source/_guides-vs-training.qmd index b155667e0e..1f196f40fe 100644 --- a/internal/templates/single-source/_guides-vs-training.qmd +++ b/internal/templates/single-source/_guides-vs-training.qmd @@ -10,20 +10,20 @@ SPDX-License-Identifier: AGPL-3.0 AND ValidMind Commercial --> :::: {.content-visible unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model by clicking on it or find your model by applying a filter or searching for it.^[[Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models)] +1. Select a record or find your record by applying a filter or searching for it.^[[Working with the inventory](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records)] -1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. +1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. :::: - :::: {.content-hidden unless-format="revealjs"} 1. In the left sidebar, click **{{< fa cubes >}} Inventory**. -1. Select a model by clicking on it or [find your model by applying a filter or searching for it](/guide/model-inventory/working-with-model-inventory.qmd#search-filter-and-sort-models). +1. Select a record or [find your record by applying a filter or searching for it](/guide/inventory/working-with-the-inventory.qmd#search-filter-and-sort-records){target="_blank"}. + +1. In the expanded sidebar that appears for your record, click **{{< fa wifi >}} Activity**. -1. In the expanded sidebar that appears for your model, click **{{< fa wifi >}} Model Activity**. +:::: -:::: \ No newline at end of file diff --git a/site/_extensions/validbeck/sidebar-slim/README.md b/site/_extensions/validbeck/sidebar-slim/README.md new file mode 100644 index 0000000000..2e191076e4 --- /dev/null +++ b/site/_extensions/validbeck/sidebar-slim/README.md @@ -0,0 +1,72 @@ +# Sidebar slim + +When `sidebar-slim: true` is set, users can collapse the docked side navigation to a narrow vertical strip to reduce visual clutter. State is kept for the browser tab (`sessionStorage`). + +## Usage + +### Setup + +Enable the filter globally in the project `format` section (`site/_quarto.yml`) so that its functionality can be called: + +```yaml +filters: + - tachyons + - preview + - validbeck/sidebar-slim +``` + +This is the currently applied functionality. + +### Enabling + +#### Enable for a single page + +In the `.qmd` YAML frontmatter set: + +```yaml +sidebar-slim: true +``` + +#### Enable for an entire section (directory) + +In that directory's `_metadata.yml` set: + +```yaml +sidebar-slim: true +``` + +Any `.qmd` under that directory inherits this unless overridden per file. + +This is the current functionality that applies to `site/guide/`. + +#### Enable for the entire project + +In the project configuration (`site/_quarto.yml`), set default metadata so every page inherits it: + +```yaml +metadata: + sidebar-slim: true +``` + +Per-directory `_metadata.yml` or a single document’s YAML can still override this (for example, `sidebar-slim: false` on one page). + +### Configuration + +#### Default to collapsed (narrow) sidebar + +Use **`sidebar-narrow: true`** so the first visit in a tab starts **collapsed** (until the user toggles). Preference is stored in `sessionStorage` (`1` = collapsed, `0` = expanded). + +Example: + +```yaml +sidebar-narrow: true +``` + +This is the functionality currently set on `site/guide/guides.qmd`. + +## Notes + +- Extension only applies to **HTML** (`html:js`) output. +- Toolbar appears at **≥992px** width; below that, Quarto’s own responsive sidebar behavior applies and this extension removes its UI. +- When collapsed, the **main column width stays the same**; only the sidebar UI narrows inside its layout area (the grid tracks for the article are unchanged). +- Does not replace Quarto’s built-in **reader mode** (`website: reader-mode`); you can use either or both. diff --git a/site/_extensions/validbeck/sidebar-slim/_extension.yml b/site/_extensions/validbeck/sidebar-slim/_extension.yml new file mode 100644 index 0000000000..a5494d300d --- /dev/null +++ b/site/_extensions/validbeck/sidebar-slim/_extension.yml @@ -0,0 +1,7 @@ +title: Sidebar slim toggle +author: validbeck +version: 1.0.4 +quarto-required: ">=1.4.0" +contributes: + filters: + - sidebar-slim.lua diff --git a/site/_extensions/validbeck/sidebar-slim/sidebar-slim.css b/site/_extensions/validbeck/sidebar-slim/sidebar-slim.css new file mode 100644 index 0000000000..7e18972967 --- /dev/null +++ b/site/_extensions/validbeck/sidebar-slim/sidebar-slim.css @@ -0,0 +1,89 @@ +/* + Collapsible site sidebar: narrows to a slim vertical strip (desktop). + Activated when sidebar-slim metadata is true (see sidebar-slim.lua). +*/ + +@media (min-width: 992px) { + .quarto-sidebar-slim-toolbar { + display: flex; + align-items: center; + justify-content: flex-end; + gap: 0.25rem; + padding: 0.35rem 0.4rem 0.45rem; + flex-shrink: 0; + } + + body.quarto-sidebar-slim-enabled #quarto-sidebar.sidebar { + display: flex; + flex-direction: column; + transition: + width 0.22s ease, + min-width 0.22s ease, + max-width 0.22s ease, + flex 0.22s ease; + } + + body.quarto-sidebar-slim-enabled #quarto-sidebar .quarto-sidebar-slim-toolbar { + order: -1; + } + + /* + Collapsed: narrow the sidebar element inside its grid cell only — do not change + grid-column on the sidebar or main content, so the article column does not widen. + */ + body.quarto-sidebar-slim-enabled.quarto-sidebar-slim-collapsed + #quarto-sidebar.sidebar { + width: 100% !important; + max-width: 2.75rem !important; + min-width: 0 !important; + justify-self: start; + overflow: hidden; + } + + /* + #quarto-sidebar is