Skip to content

Add inventory record type prompt to notebook templating [sc-16131] - #553

Open
emmavdh wants to merge 2 commits into
mainfrom
emma/sc-16131/notebook-templating-record-types
Open

Add inventory record type prompt to notebook templating [sc-16131]#553
emmavdh wants to merge 2 commits into
mainfrom
emma/sc-16131/notebook-templating-record-types

Conversation

@emmavdh

@emmavdh emmavdh commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

What and why?

Adds an inventory record type step to notebook generation (make notebook / e2e-notebook.ipynb) so newly authored notebooks can target Model, Agent, Use Case, Tool, or a custom free-text type.

  • Separate prompt alongside the existing role/document-type selection
  • Defaults to Model on empty input
  • Fills {record-type} placeholders in install and next-steps mini-templates

Shortcut: https://app.shortcut.com/validmind/story/16131

How to test

  1. From repo root: make notebook (or run notebooks/templates/e2e-notebook.ipynb)
  2. After role/document type, confirm the record-type prompt offers 1–4, custom 5 / free text, and Enter → Model
  3. Choose e.g. Agent with install+initialize; open the generated notebook and confirm registration/next-steps text says Agent (no leftover {record-type})
  4. Repeat with a custom value and confirm substitution

What needs special review?

Wording of {record-type} substitutions in install/next-steps mini-templates (UI labels like Register {record-type}).

Dependencies, breaking changes, and deployment notes

None. Existing published notebooks are unchanged; only the generator and mini-templates used for new notebooks are affected.

Release notes

Internal contributor tooling for notebook authoring.

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)

Ask for Model/Agent/Use Case/Tool (or custom free text, defaulting to Model) and fill {record-type} placeholders in install and next-steps mini-templates so newly generated notebooks can target different inventory record types.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh emmavdh added internal Not to be externalized in the release notes chore Chore tasks that aren't bugs or new features labels Aug 11, 2026
Reword the "record" key concept so it no longer defines a record via "such as a model" (and keep Key concepts free of variables), and genericize "model identifier credentials" to "{record-type} identifier credentials" in the code-snippet step so it follows the selected inventory record type.

Co-authored-by: Cursor <cursoragent@cursor.com>
@emmavdh emmavdh self-assigned this Aug 11, 2026
@emmavdh
emmavdh requested review from cachafla and nibalizer August 11, 2026 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chore Chore tasks that aren't bugs or new features internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant