Skip to content

[SC-16747] Document Record Intake experience - #1442

Merged
jamadriz merged 7 commits into
mainfrom
jamadriz/sc-16747-record-intake
Jul 30, 2026
Merged

[SC-16747] Document Record Intake experience#1442
jamadriz merged 7 commits into
mainfrom
jamadriz/sc-16747-record-intake

Conversation

@jamadriz

@jamadriz jamadriz commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

What and why?

Document the Record Intake experience introduced by frontend#2663 (SC-16747) and backend#3304 (SC-16745).

Before: Guides covered inventory record types, workflow step types, archive, and activity, but not the intake holding type, Inventory Record Type Change, reject-intake, or Intake lifecycle activity.

After:

  • New Record Intake guide for flag-on-create → register → classify/convert → admin change-type / reject → activity
  • Orgs choose the intake inventory record type name (no forced "Intake" type or Enable Intake button); only one type can be flagged for intake
  • Inventory Record Type Change added to workflow step types (+ conditional requirements), available when the workflow is scoped to the intake-flagged type
  • Cross-links from inventory record types, register, archive, activity, FAQ, and sidebar

How to test

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/inventory/record-intake.qmd \
  guide/inventory/manage-inventory-record-types.qmd \
  guide/workflows/workflow-step-types.qmd \
  guide/workflows/conditional-step-requirements.qmd \
  guide/reporting/view-record-activity.qmd \
  guide/inventory/archive-delete-records.qmd \
  guide/inventory/register-records-in-inventory.qmd \
  guide/inventory/setting-up-the-inventory.qmd \
  guide/inventory/working-with-the-inventory.qmd \
  faq/faq-inventory.qmd \
  training/administrator-fundamentals/using-validmind-for-risk-management.qmd \
  training/administrator-fundamentals/organizational-oversight-reporting.qmd

What needs special review?

  • Updated to match the latest FE flow: create-time This Inventory Record Type will be used for intake checkbox (no Enable Intake CTA; no reserved intake slug).
  • Feature ships dark behind launchdarklyRolloutRecordIntake; customer docs say Intake appears when available for the organization (no LD key exposure).
  • Did not rewrite the conceptual AI-governance training “intake workflows” module — that content is a governance pattern, not this holding-type feature.
  • Backend post-conversion record-type-changed workflow trigger is documented as best-effort only.

Dependencies, breaking changes, and deployment notes

Release notes

Adds documentation for Record Intake: flag an inventory record type for intake when creating it, classify submissions with an Inventory Record Type Change workflow step (in-place conversion), change or reject intake as an admin, and review the Intake lifecycle in record activity. Learn more ...

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)

Made with Cursor

Cover Enable Intake, the Inventory Record Type Change workflow step,
in-place classification, admin change-type/reject, and Intake activity
against the frontend and backend Record Intake PRs.

Co-authored-by: Cursor <cursoragent@cursor.com>
@jamadriz jamadriz added the documentation Improvements or additions to documentation label Jul 27, 2026
@CLAassistant

CLAassistant commented Jul 27, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@jamadriz
jamadriz marked this pull request as ready for review July 27, 2026 17:53
@jamadriz
jamadriz requested review from cachafla and emmavdh July 27, 2026 17:55
@cachafla

Copy link
Copy Markdown
Contributor
image Suggested language:

Use Record Intake when non-expert submitters need a simple way to register a new entry, and authorized users later classify it into the correct inventory record type (for example Agent, Model, or Tool).

Replace Enable Intake seeding with create-time intake flagging, user-chosen type names, and workflow gating on the flagged type.

Co-authored-by: Cursor <cursoragent@cursor.com>
@jamadriz

Copy link
Copy Markdown
Contributor Author

Updated docs to match the latest Record Intake FE flow (frontend#2663):

  • Replaced Enable Intake seeding with create-time This Inventory Record Type will be used for intake.
  • Orgs choose the holding type name/slug; only one intake type; delete + recreate to reassign
  • Special stages called out; doc/artifact types N/A for intake
  • Workflow Inventory Record Type Change gated on the intake-flagged type (not a fixed intake slug)
  • Applied @cachafla’s suggested intro wording on the Record Intake guide

Document that Classification Method is audit metadata on conversion, not a wait-for-human step, and describe the intended manual-review pattern.

Co-authored-by: Cursor <cursoragent@cursor.com>
@jamadriz
jamadriz requested a review from gtagle July 29, 2026 22:31
@cachafla

Copy link
Copy Markdown
Contributor

This section is inaccurate after the latest frontend changes:
image

@jamadriz

Copy link
Copy Markdown
Contributor Author

This section is inaccurate after the latest frontend changes: image

preview was outdated

@jamadriz

Copy link
Copy Markdown
Contributor Author

@cachafla Thanks — that screenshot was from a stale PR preview build.

The source was already updated in 3a6f973 (and follow-ups): Enable Intake was replaced with create-time This Inventory Record Type will be used for intake. The validate/deploy job had been cancelled mid-rebuild when we pushed again, so the preview still showed the old section.

Preview is refreshed now:

jamadriz and others added 2 commits July 29, 2026 21:54
v1 only supports a fixed target inventory record type; align the guides
with the workflow builder UI.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@jamadriz
jamadriz added this pull request to the merge queue Jul 30, 2026
Merged via the queue into main with commit 986c994 Jul 30, 2026
3 of 5 checks passed
@jamadriz
jamadriz deleted the jamadriz/sc-16747-record-intake branch July 30, 2026 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants