FE-1456: Add a usage manual for the Python bindings - #9253
Merged
kube merged 1 commit intoAug 21, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 19, 2026 17:32
1240da1 to
1491fbd
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 19, 2026 21:12
1491fbd to
f048ada
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 19, 2026 21:44
f048ada to
ffcae61
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 19, 2026 21:53
ffcae61 to
3ff18a3
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 19, 2026 22:16
3ff18a3 to
3811508
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 20, 2026 00:50
165b64b to
a2cc6cc
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 20, 2026 01:12
a2cc6cc to
4ace5b4
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 20, 2026 01:56
4ace5b4 to
85ff59f
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 20, 2026 09:31
85ff59f to
047f6be
Compare
kube
force-pushed
the
cf/fe-1456-arch-docs-usage-manual-for-the-python-bindings
branch
from
August 20, 2026 10:09
047f6be to
02ba2b2
Compare
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🌟 What is the purpose of this PR?
Implements FE-1456: the CLI has a usage manual attached to its layer, the Python bindings had only a package README and docstrings. A caller who wants to drive Petrinaut from Python now has the same kind of guide in the docs site, attached to the
python-bindingslayer.Top of stack #9226, on FE-1415.
🔗 Related links
🔍 What does this change?
One new authored page,
content/python-bindings/usage-manual.mdx, plus a one-line cross-link from the CLI manual. Sections: depending on the package, opening a session, run requests, optimization studies, errors, timeouts and shutdown, end to end.It documents the Python layer and links to the CLI manual for wire-level detail rather than repeating it. Every symbol, default, and limit was checked against the source, which corrected several claims the package README implies:
PetrinautRunErrorextendsRuntimeErrordirectly; onlyPetrinautProtocolErrorextendsPetrinautClientErrorseedsPerTrialstudyis not an object, and booleans are rejectedPETRINAUT_CLI_NODE_OPTIONSis forwarded, under the child'sNODE_OPTIONSPre-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:
🛡 What tests cover this?
lint:arch-docsvalidatesattachToand everydoc:/layer:target, so a stale link fails the build. Authored pages go from 15 to 16.❓ How to test this?
turbo run dev --filter @apps/petrinaut-docs/architecture/python-bindings/usage-manual: it appears under thepython-bindingslayer beside its Overview, and its links to the CLI manual resolve.🐾 Next steps
The CLI manual keeps its em dashes, so the two pages differ in punctuation style. Bringing the older page in line with the prose rules is a separate cleanup.
🤖 Generated with Claude Code