Update the documentation to support the new packmind-cli playbookworkflow#277
Merged
vincent-psarga merged 11 commits intomainfrom Apr 8, 2026
Merged
Update the documentation to support the new packmind-cli playbookworkflow#277vincent-psarga merged 11 commits intomainfrom
packmind-cli playbookworkflow#277vincent-psarga merged 11 commits intomainfrom
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
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 (7)
📝 WalkthroughWalkthroughThe pull request consolidates multiple agent creation commands into a single Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Remove reference to obsolte `skills add` command Remove outdated note
Drop useless doc
Contributor
Greptile SummaryThis PR updates the end-user documentation to reflect the new unified
Confidence Score: 4/5Safe to merge after addressing the missing The bulk of the changes are well-executed documentation updates with no logic errors. One P1 finding: apps/doc/tools/cli.mdx —
|
| Filename | Overview |
|---|---|
| apps/doc/tools/cli.mdx | Updated Skills/Standards/Commands sections to reference new playbook add/submit --no-review flow, but the playbook submit reference table omits the new --no-review flag entirely. |
| apps/doc/getting-started/gs-create-skill.mdx | Rewritten to use /packmind-update-playbook and playbook add/submit --no-review; multi-skill bulk upload example omits --no-review without explanation, inconsistent with the single-skill example above it. |
| apps/doc/getting-started/gs-create-standard.mdx | Replaced JSON-based standards create workflow with markdown file + playbook add workflow; content is consistent and accurate. |
| apps/doc/concepts/commands-management.mdx | Updated to /packmind-update-playbook skill; CLI examples correctly show playbook submit (without --no-review) for the change-proposal path, with an Info box guiding users who want direct updates. |
| apps/doc/concepts/skills-management.mdx | Updated CLI examples to playbook add/submit --no-review; consistent with the rest of the skills documentation. |
| apps/frontend/src/domain/skills/components/SkillsImportContent.tsx | Updated in-app import wizard to use playbook add/submit (without --no-review); the --no-review inconsistency vs. documentation was previously flagged in earlier review threads. |
| apps/cli/docs/commands/standard-create.md | Deleted obsolete standards create command docs; correctly removed as the command is being replaced by the playbook workflow. |
| apps/doc/playbook-maintenance/updating-your-playbook.mdx | Expanded direct-update section from skills-only to all artifact types using playbook add/submit --no-review; no issues found. |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Developer wants to create/update a playbook artifact] --> B{Method}
B --> |AI-assisted| C["/packmind-update-playbook description"]
B --> |Manual CLI| D["Edit local file (.packmind/, .claude/rules, etc.)"]
C --> E["packmind-cli playbook add path"]
D --> E
E --> F{Submit mode}
F --> |--no-review| G["Direct update (new version immediately)"]
F --> |no flag| H["Change proposal (team review in web app)"]
G --> I[Artifact updated in Packmind]
H --> J[Team reviews and approves]
J --> I
Reviews (3): Last reviewed commit: "Fix various issues shown by Code Rabbit" | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Nitpick comments (1)
apps/doc/tools/import-from-knowledge-base.mdx (1)
43-45: Consider adding a brief mention of how to create artifacts.The bullets now describe what can be imported but don't mention how to create these artifacts. A brief note about using
packmind-update-playbook(similar to other docs) would help maintain consistency and guide users.📝 Suggested addition
- **Standards** — Convert coding guidelines and conventions pages into enforceable standards that AI agents follow when generating code. - **Commands** — Turn step-by-step process documentation into reusable commands that automate multi-step workflows. - **Skills** — Create skills from pages containing relevant domain knowledge that enriches AI agent capabilities. + +Use the `packmind-update-playbook` skill in your AI coding assistant to create these artifacts from your imported content.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/doc/tools/import-from-knowledge-base.mdx` around lines 43 - 45, Add a brief note explaining how to create imported artifacts by referencing the packmind-update-playbook command used elsewhere: update the "Standards / Commands / Skills" bullets in import-from-knowledge-base.mdx to include one sentence that instructs users to create or update the corresponding artifact using the packmind-update-playbook tool (mention the exact command name packmind-update-playbook), mirroring other docs for consistency and guiding users on how to produce those Standards, Commands, and Skills before importing them.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@apps/doc/concepts/commands-management.mdx`:
- Line 100: Replace the incorrect phrase "`playbook`command of the cli" with the
corrected text "`playbook` command of the CLI" in the content (look for that
exact phrase in apps/doc/concepts/commands-management.mdx) so there is a space
after the inline code and "CLI" uses proper casing.
In `@apps/doc/concepts/standards-management.mdx`:
- Around line 78-81: The sentence about the `--no-review` flag is ambiguous;
rewrite the passage referencing `--no-review` so it explicitly states that using
`--no-review` triggers a direct update and disables the change-proposals
validation, and that validation via the change-proposals system occurs only when
`--no-review` is omitted (i.e., do not pass `--no-review` to get validation).
Update the text around the `--no-review` mention and the links to [direct
update] and [change proposals] to reflect this clear, unambiguous meaning.
In `@apps/doc/getting-started/gs-create-skill.mdx`:
- Line 75: The for-loop is using a quoted glob so the shell doesn't expand
.claude/skills/*/; update the loop that iterates over directories (the `for dir
in ...; do packmind-cli playbook add "$dir"; done` line) to use an unquoted glob
pattern so the shell expands the wildcard (i.e., remove the surrounding quotes
around .claude/skills/*/), ensuring `packmind-cli playbook add "$dir"` is
invoked for each actual skill directory.
In `@apps/doc/getting-started/gs-create-standard.mdx`:
- Around line 79-80: The CLI example uses an inconsistent path and omits the
submit step: update the command block to use a consistent directory (choose
either ./packmind/... or .packmind/... and make both occurrences match), and add
the missing submission command so the staged standard is actually submitted
(include the sequence: packmind-cli playbook add <path-to-standards-file>
followed by packmind-cli playbook submit). Ensure the referenced commands are
exactly "packmind-cli playbook add" and "packmind-cli playbook submit" so
readers can follow the full flow.
In `@apps/doc/playbook-maintenance/updating-your-playbook.mdx`:
- Line 22: Fix the typo in the sentence "Standard, commands and skills can be
directly imported or updated using the CLI:" by pluralizing "Standard" to
"Standards" so the line reads "Standards, commands and skills can be directly
imported or updated using the CLI:"; update that exact sentence in the document
to match the rest of the docs' terminology.
In `@apps/doc/tools/cli.mdx`:
- Line 22: Update the command description for "playbook add" to fix grammar and
spelling: change "Stage a change between a local files and Packmind artefacts"
to "Stage a change between local files and Packmind artifacts" (remove the
extraneous "a" before "local files" and replace "artefacts" with "artifacts");
edit the string where "playbook add" is defined in apps/doc/tools/cli.mdx.
- Around line 846-847: The docs currently show only the staging step
"packmind-cli playbook add path/to-command.md" which doesn't actually
create/update the command; add the submission step "packmind-cli playbook
submit" immediately after the add command so the flow stages then submits the
playbook, ensuring the command is created/updated in Packmind. Reference the
existing CLI commands: packmind-cli playbook add and packmind-cli playbook
submit and ensure ordering is add → submit.
In `@apps/frontend/src/domain/skills/components/SkillsImportContent.tsx`:
- Around line 331-335: The displayed terminal command in SkillsImportContent
uses "playbook submit" but the docs expect "playbook submit --no-review"; update
the CopiableTextField value in the SkillsImportContent component to include the
--no-review flag (i.e., change the string passed to CopiableTextField) so the UI
matches documentation and clarifies imports skip review; ensure you only edit
the value prop in the CopiableTextField usage to "packmind-cli playbook add
<skill-directory> && packmind-cli playbook submit --no-review".
---
Nitpick comments:
In `@apps/doc/tools/import-from-knowledge-base.mdx`:
- Around line 43-45: Add a brief note explaining how to create imported
artifacts by referencing the packmind-update-playbook command used elsewhere:
update the "Standards / Commands / Skills" bullets in
import-from-knowledge-base.mdx to include one sentence that instructs users to
create or update the corresponding artifact using the packmind-update-playbook
tool (mention the exact command name packmind-update-playbook), mirroring other
docs for consistency and guiding users on how to produce those Standards,
Commands, and Skills before importing them.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: d9d9a2a7-a420-4b0c-bbdb-e7b71a543f98
📒 Files selected for processing (16)
apps/cli/docs/commands/standard-create.mdapps/doc/concepts/commands-management.mdxapps/doc/concepts/packages-management.mdxapps/doc/concepts/skills-management.mdxapps/doc/concepts/standards-management.mdxapps/doc/getting-started/gs-cli-setup.mdxapps/doc/getting-started/gs-create-command.mdxapps/doc/getting-started/gs-create-skill.mdxapps/doc/getting-started/gs-create-standard.mdxapps/doc/governance/distribution.mdxapps/doc/index.mdxapps/doc/playbook-maintenance/updating-your-playbook.mdxapps/doc/security/security-privacy.mdxapps/doc/tools/cli.mdxapps/doc/tools/import-from-knowledge-base.mdxapps/frontend/src/domain/skills/components/SkillsImportContent.tsx
💤 Files with no reviewable changes (1)
- apps/cli/docs/commands/standard-create.md
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Contributor
|
Tip: Greploops — Automatically fix all review issues by running Use the Greptile plugin for Claude Code to query reviews, search comments, and manage custom context directly from your terminal. |
|
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.
Explanation
Next release of the cli will include
playbook submit --no-review- these changes in the documentation will cover the new flows.packmind-cli diff,packmind-cli <artifact> create)Relates to #
Type of Change
Affected Components
Testing
Test Details:
TODO List
Reviewer Notes
Summary by CodeRabbit
Documentation
Chores