H-6411: Add some basic user-facing documentation for Petrinaut#8624
H-6411: Add some basic user-facing documentation for Petrinaut#8624
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
alex-e-leon
left a comment
There was a problem hiding this comment.
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)
Updated the useful patterns documentation with images and examples for better clarity.
See the output of git range-diff at https://github.com/hashintel/hash/actions/runs/24399218063
PR SummaryLow Risk Overview Removes the old non-stochastic Reviewed by Cursor Bugbot for commit 695d001. Bugbot is set up for automated code reviews on this repo. Configure here. |
🤖 Augment PR SummarySummary: Adds an initial user-facing documentation set for Petrinaut and exposes it via a new “Docs” menu item in the editor. Changes:
Technical Notes: The Docs link targets the 🤖 Was this summary useful? React with 👍 or 👎 |
See the output of git range-diff at https://github.com/hashintel/hash/actions/runs/24476982394
|
Just 1 question/comment, otherwise LGTM 🙇♀️ |
See the output of git range-diff at https://github.com/hashintel/hash/actions/runs/24478768216
🌟 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 this require a change to the docs?
The changes in this PR:
🕸️ Does this require a change to the Turbo Graph?
The changes in this PR:
BLOCKED ON
📹 Demo
See https://github.com/hashintel/hash/blob/9c33aa962287035071bbbaaf84b9a7b8d7099018/libs/%40hashintel/petrinaut/docs