docs: Add public "Using the documentation" hub page#1300
Merged
Conversation
Add a site map and section intent page to help users navigate the documentation and to provide structured content for RAG retrieval. The page covers all major documentation sections with intent descriptions and typical tasks. Closes sc-15631
Contributor
|
Pull requests must include at least one of the required labels: |
Contributor
|
Pull requests must include at least one of the required labels: |
- Move file from about/ to about/contributing/ - Update _quarto.yml navigation to place under Contributing
- Make section headers link to their landing pages - Update Guides table to link to guides.qmd anchors instead of individual pages - Fix table formatting (remove double pipes)
- #inventory → #model-inventory (matches actual section name) - #integrations → direct link to managing-integrations.qmd (no section on guides page) - #documents-templates → direct link to working-with-model-documents.qmd (no section) - Rename "Inventory" to "Model inventory" for consistency
Points agents to the "Using the documentation" page as the starting point for understanding the docs structure and navigation.
Contributor
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: 7c2e391 Modify the workflow to check a different depth:
|
4 tasks
kam-validmind
approved these changes
Apr 30, 2026
Code reviewFound 4 issues:
documentation/site/about/contributing/using-the-documentation.qmd Lines 53 to 56 in b2a73ea
documentation/site/about/contributing/using-the-documentation.qmd Lines 95 to 99 in b2a73ea
Lines 29 to 33 in b2a73ea
documentation/site/_quarto.yml Lines 115 to 119 in b2a73ea 🤖 Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
- Fix broken anchor #model-inventory → #inventory in guides table - Add chatbot screenshot for in-product help section - Convert AGENTS.md links to absolute HTTPS URLs - Move using-the-documentation.qmd to end of About sidebar
Contributor
PR SummaryThis pull request introduces several improvements to the ValidMind documentation site aimed at clarifying guidance for both agents and end-users. The key changes are:
Overall, the changes improve the navigability and usability of the documentation site, thereby supporting better user onboarding and in-app assistance experience. Test Suggestions
|
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
Collaborator
Author
|
Review comments addressed in 194be31 |
nrichers
added a commit
that referenced
this pull request
May 2, 2026
* Edit: Managing your organization > Manage document defaults (#1268) * docs: Settings redesign / overhaul (#1266) * Managing your organization + Manage business units * Set up your organization * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Update: Manage platform notifications > Customize email notifications * Cleanup: Integrations examples * Edit: Manage groups * proofread * proofread x2 * proofread x3 * Edit * Edit: Manage roles * proofread * proofread x2 * Edited: Manage model stakeholder types * Proofread: Admin quickstart + related includes * Proofread: Manage users * Proofread: Manage roles * Proofread: Manage model stakeholder types * Proofread: Manage permissions * Proofread: Workflow states * Proofread: Manage model stages * Proofread: Configure workflows * Proofread: Manage model inventory fields * Proofread: Manage document types * Proofread: Manage artifact types * Save point * Proofread: Manage artifact severities * Proofread: Manage artifact fields * UI adjustments Made-with: Cursor * Edit * Edit 2 * Fixing some weird footnotes * Edit * Edit * Not sure why settings file was included * docs: Edit active workflow end dates (#1270) * WIP * Edit: Manage workflows > Update active workflows * docs: add HTTP proxy guide for ValidMind Library - New page covering proxy env vars and troubleshooting - Link from ValidMind Library sidebar * Edits * docs: View, sort, and filter workflows (#1273) * Edit * wip * Edit: Workflow step types * Edit: Confitional requirements * Glossary fix * Fixing About library & platform page * Fixing a broken breadcrumb * Edit: Configure workflows * proofread * Setting up workflows: +View, sort, and filter workflows * Proofread * Edit: John's suggestions * Address review comments from Spencer * Edit * Final edits * Start attestations FAQ & explain attestation visibility before period starts * docs(attestation): tighten callout wording for sidebar visibility * Add new export option, fix smallercaps placement * Webhook secrets updates (#1282) * Initial draft with edits * Edits after testing * Fix render warnings * docs: Document Checker expansion & Guides update (#1284) * sidebar shuffle * Renaming document checker guide * wip edit: Customize document checker * Save point * Save point * Unhiding generate assessment from PDF * Rename: Check documents for compliance * Edit * Edit: Check documents for compliance * Adding check documents for compliance to validation * Admin training edit * Screenshot rename or update * Validation training — + Document Checker * Proofreading * Fixing the cookie issue for the external previews * Edit * Shuffling wip * guides landing reshuffle * Save point * Testing... * More testing * more * Save point * Save point * Edit * Edit * Tweak * Editing extension README * Edit * Edit * Forgot the footer links, standarizing breadcrumb casing * Kam's suggestions * Oops, accidentally committed Cursor plans * docs: Enabling org-wide track changes disables AI-content drafts (#1288) * Edited: Managing your organization * Edited: Work with content blocks * Edit 1 * Edit 2 * Edit: Manage text block library * Proofread * docs: Export document checker results (#1290) * Edit: Check documents for compliance * proofread * documentation: Save drafts for workflow user action submissions (#1291) * Edit: Transitition workflows * Proofreading * Update as per JAM's comments * docs: Workflow draft state (#1293) * Setup for workflow drafts * WIP: Publishing workflows * Save point * Training WIP * Edited: Using ValidMind for Model Risk Management * Edited: Setting up workflows * Updated: Filtering workflows * Edits as per Luis's suggestion * docs: Models > records docs update phase 1 (#1287) * model-inventory directory > inventory * Renaming files in inventory/ * Patching footer, oops Made-with: Cursor * Renaming more files in inventory/ * inventory/_embeds edit * Model Inventory > Inventory; Model Activity > Activity; anchor link * Edit: inventory/ pt1 Made-with: Cursor * Setup for Manage inventory record types * Edit: inventory/pt2 Made-with: Cursor * Rename: Manage model stakeholder types > Manage record stakeholder types * Editing: Manage record stakeholder types * Save point * Save point * Edited: Manage record stakeholder types * Cleanup... * Edit: Work with filters * Proofreading * Proofread: Old inventory/ guides * Proofread: Administrator Fundamentals training * WIP * WIP: Manage inventory record types > Add record types * Manage inventory record types draft * Save point * Editing Administrator Fundamentals training * Admin training WIP edit * +Record types to admin training * Copyright headers * Changing installation ref branch, remove after * missed some anchor links * one more * Update .github/workflows/validate-docs-site.yaml * Fixing borked links * oops, missed one * docs: Add public "Using the documentation" hub page (#1300) * docs: Add public "Using the documentation" hub page Add a site map and section intent page to help users navigate the documentation and to provide structured content for RAG retrieval. The page covers all major documentation sections with intent descriptions and typical tasks. Closes sc-15631 * Move using-the-documentation to Contributing section - Move file from about/ to about/contributing/ - Update _quarto.yml navigation to place under Contributing * Add links to section headers and update table links - Make section headers link to their landing pages - Update Guides table to link to guides.qmd anchors instead of individual pages - Fix table formatting (remove double pipes) * Fix anchor links to match actual guides.html structure - #inventory → #model-inventory (matches actual section name) - #integrations → direct link to managing-integrations.qmd (no section on guides page) - #documents-templates → direct link to working-with-model-documents.qmd (no section) - Rename "Inventory" to "Model inventory" for consistency * Revert label to 'Inventory' (current terminology) * Add validmind-chatbot.png to In-product help section * Add AGENTS.md to guide AI agents to documentation hub Points agents to the "Using the documentation" page as the starting point for understanding the docs structure and navigation. * Add chatbot capabilities reference to AGENTS.md * docs: Address review feedback for documentation hub page - Fix broken anchor #model-inventory → #inventory in guides table - Add chatbot screenshot for in-product help section - Convert AGENTS.md links to absolute HTTPS URLs - Move using-the-documentation.qmd to end of About sidebar * docs: Add unlisted chatbot capabilities page (Phase 1-2) (#1298) * docs: Add unlisted chatbot capabilities page (Phase 1-3) Adds an unlisted documentation page describing what the in-app assistant can and cannot do across product phases. Includes clear boundaries, limitations, and distinction from MCP integration. Resolves sc-15632 * fix: Update chatbot capabilities to reflect Phase 2 as current - Remove phase-based structure since Phase 2 is now the current state - Document context-aware capabilities as current (understands location, permission-aware) - Keep action execution as a future capability (Phase 3) - Simplify structure to Current / Future / Limitations - Update comparison table to reflect context awareness * Remove Future capabilities section * Use 'refer to' instead of 'see' * docs: Add live query scope limitation to chatbot capabilities Clarifies that live queries currently support model inventory and artifacts only — workflows, analytics, and other areas are not yet available. * fix: Use search: false instead of listing: false * docs: Add autogenerate validation issues documentation (#1304) * docs: Add autogenerate validation issues documentation Document the AI-powered feature that suggests validation issues based on risk assessment notes during compliance assessment. Validators can review, approve, or dismiss AI-generated suggestions. [sc-15712] * Simplify navigation: click Validation link directly * docs: Add public "Using the documentation" hub page (#1300) * docs: Add public "Using the documentation" hub page Add a site map and section intent page to help users navigate the documentation and to provide structured content for RAG retrieval. The page covers all major documentation sections with intent descriptions and typical tasks. Closes sc-15631 * Move using-the-documentation to Contributing section - Move file from about/ to about/contributing/ - Update _quarto.yml navigation to place under Contributing * Add links to section headers and update table links - Make section headers link to their landing pages - Update Guides table to link to guides.qmd anchors instead of individual pages - Fix table formatting (remove double pipes) * Fix anchor links to match actual guides.html structure - #inventory → #model-inventory (matches actual section name) - #integrations → direct link to managing-integrations.qmd (no section on guides page) - #documents-templates → direct link to working-with-model-documents.qmd (no section) - Rename "Inventory" to "Model inventory" for consistency * Revert label to 'Inventory' (current terminology) * Add validmind-chatbot.png to In-product help section * Add AGENTS.md to guide AI agents to documentation hub Points agents to the "Using the documentation" page as the starting point for understanding the docs structure and navigation. * Add chatbot capabilities reference to AGENTS.md * docs: Address review feedback for documentation hub page - Fix broken anchor #model-inventory → #inventory in guides table - Add chatbot screenshot for in-product help section - Convert AGENTS.md links to absolute HTTPS URLs - Move using-the-documentation.qmd to end of About sidebar * docs: Add Bedrock evaluation metrics integration documentation (#1303) * docs: Add Bedrock evaluation metrics integration documentation Document the new integration metrics feature for monitoring documents: - Add "From Integration" tab flow for adding Bedrock Agent Evals - Add global time selector section for monitoring documents - Document connection detail page with metric sources - Add metric sources management section for Bedrock connections * Add health monitoring section from #1297 to simplify merging * Add 'feature' and simplify monitoring navigation * Update global time range section with correct terminology - Rename "time selector" to "time range" to match UI - Add clock icon reference - List available options (All Time, relative presets, Custom range) - Note that setting is only visible to the current user * Fix integration metric configuration options - Add both threshold (lower) and threshold (upper) fields - Rename "time window" to "time range" to match UI - Expand time range description with available options * Use commas instead of em-dashes for parenthetical phrases * docs: Address review feedback for Bedrock integration docs - Update step 7 to describe Evaluators list instead of Bedrock Agent Evals - Rename Metric Sources references to Monitoring to match UI tab name * docs: Document Model Activity in Analytics Data Export (#1302) * docs: Add Model Activity to analytics data export datasets Add Model Activity as an available dataset option in Analytics Data Export configuration. Model Activity exports audit events (comments, workflow status changes, field updates) for compliance reporting and audit trails. Shortcut: sc-15291 * Add custom artifact types and inventory record types to export list * Change colon to 'For example:' * docs: Clarify Model Activity date filtering options Change "date range filtering" to "30, 60, or 90-day window filtering" to accurately reflect the fixed window picker in the UI. * docs: add visibility into integrations health (#1297) * docs: add visibility into integrations health Add documentation for the new Connections dashboard that provides visibility into integration health, including status indicators, linked models, metric sources, and troubleshooting guidance. [sc-15885] * Fix: connections with issues show status indicator, not sorted to top * Add example status indicator for sync errors * Fix connection status labels and colors to match frontend * Clarify Linked Models shows both VM records and external models * Fix: describe linked models table with correct column names * Use vm.product variable instead of hardcoded ValidMind * docs: Remove inaccurate Recent activity bullet The connection details page has Links and Monitoring tabs, not a recent activity/sync history section. Sync errors appear as badges on the row, not in a feed. * Preview for 26.05 release notes + `make get-source` (#1305) * Add temporary release-notes branch ref for 26.05 preview Points to nrichers/sc-15927/release-notes-for-26-05 branch in release-notes repo. * Run make get-source * Give tables on all-releases page more room * Move 2025 releases into their own section * Experiment with excluding releases/ from search * Remove branch ref --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why?
Creates a public "Using the documentation" hub page (sc-15631) and adds an AGENTS.md file to help AI agents discover it. Provides a site map covering all major documentation sections, their intent, typical tasks, and role-based entry points to help users and agents navigate the docs effectively.
How to test
Try the live preview:
What needs special review?
Dependencies, breaking changes, and deployment notes
Release notes
Added a documentation hub page with site map and section-by-section guide to help users find the right content for their role and task. Added AGENTS.md to guide AI agents to the hub as their starting point.
Checklist