FE-1413: Cover petrinaut-cli in the architecture docs and attach a usage manual - #9227
Draft
Conversation
…age manual Registers @hashintel/petrinaut-cli in the architecture bundle with a cli root layer and cli.commands/cli.runtime sub-layers, plus a core-must-not- import-cli rule and a diagram colour. The package's long-form docs move into an authored usage manual attached to the cli layer - rewritten and reorganized from README.md and OPTIMIZATION_INTEGRATION.md, which become stubs pointing at it; links into the old files are updated. The alias deriver now warns when a registered package exposes no importable entry points (bin-only packages exempt), closing the silent-edge-loss hole.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
github-actions
Bot
added
area/infra
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
1 participant
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?
The architecture docs covered only
petrinaut-coreandpetrinaut; the CLI's long-form documentation lived in package-local markdown that drifts and never reaches the docs site. This PR registers the CLI in the architecture bundle and moves its documentation into an authored usage manual attached to the newclilayer.Stack #9226: FE-1410 → FE-1411 → FE-1408 → this PR → (next: FE-1270 Python bindings, FE-1412).
🔗 Related links
🔍 What does this change?
Architecture bundle
@hashintel/petrinaut-cli; declares thecliroot layer (@layerRootincli.ts) andcli.commands/cli.runtimesub-layers (README frontmatter). Result: 40 layers, 182 edges, 423 files — the 4 new edges are the CLI's real imports into core.coremust not importcli(the engine cannot depend on its packaging).cliroot.deriveAliasesnow warns when a registered package exposes no importable entry points — imports of such a package would silently vanish from the graph. Bin-only packages (like the CLI) are exempt, so the warning is quiet today and catches genuine mistakes.Usage manual (
content/cli/usage-manual.mdx, attached tocli)README.md+OPTIMIZATION_INTEGRATION.md, not copied.MODEL_EXAMPLES.md,PYTHON_INTEGRATION.md, the user guide'sexamples.md) now point at the manual.Pre-Merge Checklist 🚀
🚢 Has this modified a publishable library?
This PR:
📜 Does this require a change to the docs?
The changes in this PR:
examples.mdmoved; the docs-content test passes).🕸️ Does this require a change to the Turbo Graph?
The changes in this PR:
🛡 What tests cover this?
yarn workspace @local/petrinaut-arch-docs lint:arch-docs— validates the new package registration, layer declarations, full file coverage, the new rule, and the manual'sattachTo.doc:architecturebundle build.petrinaut-docs-content.test.ts— the user guide still bundles cleanly.❓ How to test this?
yarn workspace @local/petrinaut-arch-docs lint:arch-docsturbo run dev --filter @apps/petrinaut-docsand open Architecture → cli → Usage manual.🤖 Generated with Claude Code