docs: Delete and archive artifact types by validbeck · Pull Request #1228 · validmind/documentation

validbeck · 2026-03-20T17:26:33Z

Pull Request Description

What and why?

sc-15238

You can now archive (and delete, for custom types) artifact types. Documentation updated to reflect this functionality.

How to test

Click on the live preview for the net-new section:

page	OLD	NEW
Manage artifact types	artifact-types-old.mov	artifact-types-new.mov

What needs special review?

For some reason I recall us being able to toggle default fields on artifact types previously (makes sense since it's... part of the setup when you click on a type) but you no longer can: https://validmind.slack.com/archives/C06JS5D1DNV/p1774025565126169

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Covered by https://github.com/validmind/frontend/pull/2263.

Checklist

nateshim

lgtm! left a couple of comments

github-actions · 2026-03-20T19:20:34Z

PR Summary

This PR introduces several enhancements to the artifact types documentation in the model validation guide. The changes detail the following improvements:

In the edit page for artifact types, a minor formatting update adds a new line that separates the main content from additional footnotes.
In the management guide, the section titles and descriptions have been updated to better distinguish between native (default) and custom artifact types. The language now clearly indicates that the platform provides "three native artifact types" by default.
The content outlining how custom artifact types work has been refactored into a callout section that expands and collapses, providing a more interactive and visually distinct explanation for creating custom artifact types.
A new section has been added to the guide that explains how to archive and delete artifact types. This section emphasizes that archiving is a reversible process for custom types (deletion is permanent and requires certain conditions) and lays out detailed, step-by-step instructions for archiving, deleting, and restoring artifact types. Callout and panel-tabset components are used to highlight important security and usability notes.

These changes collectively improve the clarity, navigability, and accuracy of the documentation concerning artifact type management, providing better guidance for end users on both configuration differences and lifecycle management options.

Test Suggestions

Manually verify that the new callout sections (for custom artifact types and archive/delete instructions) render correctly across different browsers and devices.
Confirm that the updated instructions in the archive and delete section accurately reflect the UI workflow for archiving, deleting, and restoring artifact types.
Check that the new footnote reference [^4] links correctly to the intended section within the documentation.

github-actions · 2026-03-20T19:57:33Z

Validate docs site

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

* Expand custom artifact type content * Add margin footnote link * Change to definition list * Edits * docs: Organization wide default tracking changes in content blocks (#1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread * docs: Insert inventory & artifact field values as variables into documents & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights * docs: Individual model inventory field activity (#1206) * WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Fixing numbering * Fixing indenting --------- Co-authored-by: Nik Richers <nik@validmind.ai> * feat: docs pipeline to render markdown * feat: bump quarto to pre-release * chore: run llm gen at the end so we don't delay pr previews * LUA filter + Pandoc post-processing experiment * docs: 'document' parameter in `vm.init()` for model document target (#1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module * feat: make llm publishing slimmer- no release no installation no library * chore: put vm-library llm docs back * Switch to sparse checkout for some repos * fix: errors in publish llm gha * chore: handle the case where branch name is not main or prod, for instance when testing * Add "Quick reference" section to test overview page (#1205) * Add key concepts section to test overview page * Make section a callout, change to quick reference * Save point for graphviz * Some graphviz tweaks * A few more tweaks * Fill colour tweak * Document vm_today and datetime support in calculated fields (#1167) * Document vm_today and datetime support in calculated fields Add collapsible example for date arithmetic in model inventory calculation fields: vm_today, date, datetime, timedelta, relativedelta. Includes next review date and days-remaining countdown examples. Notes timestamp input and string output behavior. [sc-7465] * Fix whitespace * Fix heading level and move inventory field types up one section * Add screenshots, edits after testing * Save point before moving content * Move into its own file and relocate * Better intro * Restore better vm_today example * Edits * Minor text reschuffle * Mention fields by name * Move field types reference content below prequisites and bump to h2 * Fix example casing * Consistency edit * Rename and restructure Supported Models page (#1163) * Rename and restructure Supported Models page - Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd * Fix missed sidebar update * Fix broken link * Add bridging sentence after callout * Re-add a what does supported mean heading * Minor edit * Re-add some old goodness * Much better detail * Edits * More edits * Edits * Remove old supported models page * Minor edit * Edits * File rename again * Remove duplicated embeddings content * Uncomment and move info about tests for text-generating models * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Switch to definition list after removing lead-in text for bulleted list * Two columns for a neater layout * Remove pointless link * Add links, text edits * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Whitespace * Address review comment from Juan * Remove links I'd added --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs: Updated document type names (#1224) * WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit * docs: Delete and archive artifact types (#1228) * WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo * Add R support documentation (#1227) * Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231) * Fix CI hang: Don't try to render Graphviz diagrams with GFM (#1230) * Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Add auto-generated template schema documentation (#1166) * Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref * docs: Export analytics (#1225) * Setup: Export analytics * WIP * edit * Proofreading --------- 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> Co-authored-by: Spencer Krum <nibz@validmind.ai>

* Expand custom artifact type content * Add margin footnote link * Change to definition list * Edits * docs: Organization wide default tracking changes in content blocks (#1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread * docs: Insert inventory & artifact field values as variables into documents & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights * docs: Individual model inventory field activity (#1206) * WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd * Fixing numbering * Fixing indenting --------- * feat: docs pipeline to render markdown * feat: bump quarto to pre-release * chore: run llm gen at the end so we don't delay pr previews * LUA filter + Pandoc post-processing experiment * docs: 'document' parameter in `vm.init()` for model document target (#1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module * feat: make llm publishing slimmer- no release no installation no library * chore: put vm-library llm docs back * Switch to sparse checkout for some repos * fix: errors in publish llm gha * chore: handle the case where branch name is not main or prod, for instance when testing * Add "Quick reference" section to test overview page (#1205) * Add key concepts section to test overview page * Make section a callout, change to quick reference * Save point for graphviz * Some graphviz tweaks * A few more tweaks * Fill colour tweak * Document vm_today and datetime support in calculated fields (#1167) * Document vm_today and datetime support in calculated fields Add collapsible example for date arithmetic in model inventory calculation fields: vm_today, date, datetime, timedelta, relativedelta. Includes next review date and days-remaining countdown examples. Notes timestamp input and string output behavior. [sc-7465] * Fix whitespace * Fix heading level and move inventory field types up one section * Add screenshots, edits after testing * Save point before moving content * Move into its own file and relocate * Better intro * Restore better vm_today example * Edits * Minor text reschuffle * Mention fields by name * Move field types reference content below prequisites and bump to h2 * Fix example casing * Consistency edit * Rename and restructure Supported Models page (#1163) * Rename and restructure Supported Models page - Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd * Fix missed sidebar update * Fix broken link * Add bridging sentence after callout * Re-add a what does supported mean heading * Minor edit * Re-add some old goodness * Much better detail * Edits * More edits * Edits * Remove old supported models page * Minor edit * Edits * File rename again * Remove duplicated embeddings content * Uncomment and move info about tests for text-generating models * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Switch to definition list after removing lead-in text for bulleted list * Two columns for a neater layout * Remove pointless link * Add links, text edits * Update site/developer/supported-models-and-frameworks.qmd * Whitespace * Address review comment from Juan * Remove links I'd added --------- * docs: Updated document type names (#1224) * WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit * docs: Delete and archive artifact types (#1228) * WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo * Add R support documentation (#1227) * Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- * Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231) * Fix CI hang: Don't try to render Graphviz diagrams with GFM (#1230) * Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- * Add auto-generated template schema documentation (#1166) * Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref * docs: Export analytics (#1225) * Setup: Export analytics * WIP * edit * Proofreading --------- 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> Co-authored-by: Spencer Krum <nibz@validmind.ai>

validbeck added 3 commits March 20, 2026 09:48

WIP

dca41d5

WIP

f57b81c

Edit: Manage artifact types

5ded68a

validbeck self-assigned this Mar 20, 2026

validbeck added the internal Not to be externalized in the release notes label Mar 20, 2026

validbeck requested review from nateshim and nrichers March 20, 2026 18:00

nateshim reviewed Mar 20, 2026

View reviewed changes

Comment thread site/guide/model-validation/manage-artifact-types.qmd Outdated

nateshim reviewed Mar 20, 2026

View reviewed changes

Comment thread site/guide/model-validation/manage-artifact-types.qmd

nateshim approved these changes Mar 20, 2026

View reviewed changes

validbeck added 2 commits March 20, 2026 11:38

Edit

19cae04

Edit after Slack convo

38d7304

validbeck merged commit f9b1a95 into main Mar 20, 2026
7 of 12 checks passed

validbeck deleted the beck/sc-15238/documentation-new-artifact-type-management branch March 20, 2026 19:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Delete and archive artifact types#1228

docs: Delete and archive artifact types#1228
validbeck merged 5 commits into
mainfrom
beck/sc-15238/documentation-new-artifact-type-management

validbeck commented Mar 20, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

nateshim left a comment

Uh oh!

github-actions Bot commented Mar 20, 2026

Uh oh!

github-actions Bot commented Mar 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

validbeck commented Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Description

What and why?

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

Uh oh!

Uh oh!

Uh oh!

nateshim left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Mar 20, 2026

PR Summary

Test Suggestions

Uh oh!

github-actions Bot commented Mar 20, 2026

Validate docs site

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

validbeck commented Mar 20, 2026 •

edited

Loading