Skip to content

FE-1490: Add the ad-hoc scenarios user guide - #9290

Draft
kube wants to merge 5 commits into
cf/fe-1489-optimizations-accept-an-ad-hoc-scenariofrom
cf/fe-1490-ad-hoc-scenario-user-guide
Draft

FE-1490: Add the ad-hoc scenarios user guide#9290
kube wants to merge 5 commits into
cf/fe-1489-optimizations-accept-an-ad-hoc-scenariofrom
cf/fe-1490-ad-hoc-scenario-user-guide

Conversation

@kube

@kube kube commented Aug 22, 2026

Copy link
Copy Markdown
Collaborator

🌟 What is the purpose of this PR?

The docs layer for the ad-hoc scenario feature, closing stack #9286: a user-guide page for the shared form, cross-references in the three consumer pages, and registration with the in-app AI assistant's doc reader.

🔗 Related links

  • FE-1490 (internal): this PR
  • FE-778 (internal): the umbrella ticket

🔍 What does this change?

  • New page docs/ad-hoc-scenarios.md: where the form appears (quick simulation, experiments, optimizations), the form's sections (parameters, variables, per-place initial state), fixed vs template rows, shared columns, per-place variables, Optimize selections with the generated adhoc.* parameter names, and error surfacing. Linked from docs/README.md.
  • Cross-references: simulation.md documents the "Define initial state" pencil button; experiments.md documents the "No scenario" branch and the "Ad-hoc scenario" table label; optimization.md's prerequisites and creation steps now cover "Ad-hoc (define inline)".
  • Assistant registration: ad-hoc-scenarios added to petrinautDocNames and petrinautDocSummaries in petrinaut-core/src/ai.ts, with the ?raw import in petrinaut-docs-content.ts. The existing tests enforce that every doc name has a summary and a content entry.

Pre-Merge Checklist 🚀

🚢 Has this modified a publishable library?

This PR:

  • modifies npm-publishable libraries and I have added a changeset file (patch for both packages).

📜 Does this require a change to the docs?

The changes in this PR:

  • are the docs change.

🕸️ Does this require a change to the Turbo Graph?

The changes in this PR:

  • do not affect the execution graph.

🛡 What tests cover this?

The existing ai.test.ts and petrinaut-docs-content.test.ts tests enforce that the new doc name has a summary and a content entry.

❓ How to test this?

  1. turbo run test:unit --filter @hashintel/petrinaut --filter @hashintel/petrinaut-core
  2. Open the in-app AI assistant and ask about ad-hoc scenarios; the assistant reads the new page through readPetrinautDoc.

🐾 Next steps

The new page has no screenshots yet; they should be added once the UI is reviewed and final.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Aug 22, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hash Ready Ready Preview Aug 24, 2026 11:03am
petrinaut Ready Ready Preview Aug 24, 2026 11:03am
petrinaut-docs Ready Ready Preview Aug 24, 2026 11:03am
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
hashdotdesign-tokens Ignored Ignored Preview Aug 24, 2026 11:03am

@github-actions github-actions Bot added area/infra Relates to version control, CI, CD or IaC (area) area/libs Relates to first-party libraries/crates/packages (area) type/eng > frontend Owned by the @frontend team labels Aug 22, 2026
@kube
kube force-pushed the cf/fe-1490-ad-hoc-scenario-user-guide branch from 2c6a08f to 95db31d Compare August 23, 2026 14:18
@kube
kube force-pushed the cf/fe-1490-ad-hoc-scenario-user-guide branch from 95db31d to 1905429 Compare August 23, 2026 14:40
@kube
kube force-pushed the cf/fe-1490-ad-hoc-scenario-user-guide branch from 1905429 to 94bde30 Compare August 23, 2026 15:42
@kube
kube force-pushed the cf/fe-1490-ad-hoc-scenario-user-guide branch from 94bde30 to ba21902 Compare August 24, 2026 01:03
@kube
kube force-pushed the cf/fe-1490-ad-hoc-scenario-user-guide branch from ba21902 to e966362 Compare August 24, 2026 01:11
kube added 5 commits August 24, 2026 12:52
The guide now covers the form's keyboard grid (arrows and Tab across every
table, the count strip on the vertical path, the gutter as row selection
with Enter for the kind menu and Delete for removal), the Variables
phantom row and cell-style name editing, and the form-level undo history.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/infra Relates to version control, CI, CD or IaC (area) area/libs Relates to first-party libraries/crates/packages (area) type/eng > frontend Owned by the @frontend team

Development

Successfully merging this pull request may close these issues.

1 participant