Skip to content

H-6411: Add some basic user-facing documentation for Petrinaut#8624

Open
CiaranMn wants to merge 18 commits intomainfrom
cm/petrinaut-docs
Open

H-6411: Add some basic user-facing documentation for Petrinaut#8624
CiaranMn wants to merge 18 commits intomainfrom
cm/petrinaut-docs

Conversation

@CiaranMn
Copy link
Copy Markdown
Member

@CiaranMn CiaranMn commented Apr 13, 2026

🌟 What is the purpose of this PR?

Add some user documentation to the Petrinaut folder, and adds a 'Docs' link to the burger menu that will open that page on GitHub (this link will be broken until PR is merged).

Pre-Merge Checklist 🚀

🚢 Has this modified a publishable library?

This PR:

  • does not modify any publishable blocks or libraries, or modifications do not need publishing

📜 Does this require a change to the docs?

The changes in this PR:

  • is docs

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

The changes in this PR:

  • do not affect the execution graph

⚠️ Known issues

BLOCKED ON

  1. Adding screenshots (see placeholder markers in docs)
  2. Updating docs when we add scenarios + metrics

📹 Demo

See https://github.com/hashintel/hash/blob/9c33aa962287035071bbbaaf84b9a7b8d7099018/libs/%40hashintel/petrinaut/docs

@CiaranMn CiaranMn self-assigned this Apr 13, 2026
@vercel
Copy link
Copy Markdown

vercel bot commented Apr 13, 2026

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

Project Deployment Actions Updated (UTC)
hash Ready Ready Preview, Comment Apr 15, 2026 9:21pm
petrinaut Ready Ready Preview, Comment Apr 15, 2026 9:21pm
2 Skipped Deployments
Project Deployment Actions Updated (UTC)
hashdotdesign Ignored Ignored Preview Apr 15, 2026 9:21pm
hashdotdesign-tokens Ignored Ignored Preview Apr 15, 2026 9:21pm

@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 Apr 13, 2026
Comment thread libs/@hashintel/petrinaut/src/views/Editor/editor-view.tsx
Comment thread libs/@hashintel/petrinaut/docs/examples.md Outdated
kube
kube previously approved these changes Apr 13, 2026
Copy link
Copy Markdown
Collaborator

@kube kube left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

alex-e-leon
alex-e-leon previously approved these changes Apr 14, 2026
Copy link
Copy Markdown
Contributor

@alex-e-leon alex-e-leon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @CiaranMn - wish I had these on day 1 😉

One other thing I would love to eventually see is a "Getting started/build your first net" tutorial, that handholds you through building a simple example net.

Also a note on my review style: Any time I leave a comment with "minor" those are totally optional to action - I use "minor" to share my personal opinion, ask questions, etc, and so feel free to ignore them completely (or not - its up to you)

Comment thread libs/@hashintel/petrinaut/docs/drawing-a-net.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md Outdated
Updated the useful patterns documentation with images and examples for better clarity.
@github-actions github-actions bot dismissed stale reviews from kube and alex-e-leon April 14, 2026 12:36
Comment thread libs/@hashintel/petrinaut/docs/drawing-a-net.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/drawing-a-net.md
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/petri-net-extensions.md Outdated
@cursor
Copy link
Copy Markdown

cursor bot commented Apr 15, 2026

PR Summary

Low Risk
Primarily adds documentation and a new external link; only functional change is removing an unused example/menu entry.

Overview
Adds a new libs/@hashintel/petrinaut/docs user guide (overview + pages for drawing nets, extensions, simulation, visual settings, patterns, and built-in examples) and wires a new Docs item into the editor hamburger menu to open the docs on GitHub.

Removes the old non-stochastic supply-chain example and its "Supply Chain" load-example menu entry, leaving the probabilistic version as the remaining supply-chain example.

Reviewed by Cursor Bugbot for commit 695d001. Bugbot is set up for automated code reviews on this repo. Configure here.

@augmentcode
Copy link
Copy Markdown

augmentcode bot commented Apr 15, 2026

🤖 Augment PR Summary

Summary: Adds an initial user-facing documentation set for Petrinaut and exposes it via a new “Docs” menu item in the editor.

Changes:

  • Introduced a docs section under libs/@hashintel/petrinaut/docs covering drawing/editing nets, extensions (types/dynamics/kernels), simulation behavior/settings, visual settings, and built-in examples.
  • Added a “Docs” entry to the editor hamburger menu that opens the GitHub docs folder in a new tab.
  • Removed the older non-stochastic supply-chain example and its “Load example” menu item, leaving the stochastic/probabilistic supply-chain example.

Technical Notes: The Docs link targets the main branch path on GitHub (intended to work once merged), and opens with noopener,noreferrer for safety.

🤖 Was this summary useful? React with 👍 or 👎

Copy link
Copy Markdown

@augmentcode augmentcode bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 5 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

Comment thread libs/@hashintel/petrinaut/docs/README.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/drawing-a-net.md
Comment thread libs/@hashintel/petrinaut/docs/examples.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/useful-patterns.md Outdated
Comment thread libs/@hashintel/petrinaut/docs/visual-settings.md Outdated
kube
kube previously approved these changes Apr 15, 2026
@CiaranMn CiaranMn added this pull request to the merge queue Apr 15, 2026
@CiaranMn CiaranMn removed this pull request from the merge queue due to a manual request Apr 15, 2026
kube
kube previously approved these changes Apr 15, 2026
Comment thread libs/@hashintel/petrinaut/docs/useful-patterns.md Outdated
@drdma
Copy link
Copy Markdown
Collaborator

drdma commented Apr 15, 2026

Just 1 question/comment, otherwise LGTM 🙇‍♀️

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.

4 participants