Prepare doc for next release#281
Conversation
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR updates Packmind CLI documentation across multiple files to reflect command syntax changes. Key updates include: replacing Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Greptile SummaryThis PR updates documentation ahead of the next CLI release, replacing deprecated Confidence Score: 5/5
Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[User] --> B[packmind-cli login]
B --> C{Browse packages?}
C -->|Yes| D[packmind-cli packages list]
D --> E[packmind-cli packages show package-slug]
E --> F{Ready to install}
C -->|No, direct install| F
F --> G{Single space?}
G -->|Yes| H["packmind-cli install pkg1 pkg2"]
G -->|Multiple spaces| I["packmind-cli install @space/pkg1 @space2/pkg2"]
H --> J[packmind-lock.json created]
I --> J
J --> K[packmind-cli install — update all from packmind.json]
Reviews (1): Last reviewed commit: "Prepare doc for next release" | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| ### View Package Details | ||
|
|
||
| ```bash | ||
| packmind-cli install --show <package-slug> | ||
| packmind-cli packages show <package-slug> | ||
| ``` |
There was a problem hiding this comment.
packages show missing from command overview
The top-level command overview (the bullet list near the top of the file) lists packages create, packages add, and packages list, but packages show — which is newly introduced by this PR as a replacement for install --show — is absent. A user scanning the overview for what packages subcommands exist will miss it.
| ### View Package Details | |
| ```bash | |
| packmind-cli install --show <package-slug> | |
| packmind-cli packages show <package-slug> | |
| ``` | |
| ### View Package Details | |
| ```bash | |
| packmind-cli packages show <package-slug> |
Consider also adding a `packages show` entry to the overview list alongside `packages list`.
| ```bash | ||
| packmind-cli install backend-standards frontend-react | ||
| # Note: when using multiple spaces, you will need to prefix the packages with the space slug | ||
| packmind-cli install @backend/standards @frontend/react | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Placing both packmind-cli install backend-standards frontend-react and packmind-cli install @backend/standards @frontend/react in the same code block (with only an inline comment to differentiate them) can make it appear that a user should run both commands. Because these are alternative forms depending on whether packages live in one space or multiple, splitting them into separate blocks with a brief prose explanation would be clearer.
| ```bash | |
| packmind-cli install backend-standards frontend-react | |
| # Note: when using multiple spaces, you will need to prefix the packages with the space slug | |
| packmind-cli install @backend/standards @frontend/react | |
| ``` | |
| ```bash | |
| packmind-cli install backend-standards frontend-react |
If your packages are in different spaces, prefix them with the space slug:
packmind-cli install @backend/standards @frontend/react
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
1 participant
Update documentation about
installcommand for the next releaseSummary by CodeRabbit
packmind-cli packagesprefix (list and show)