-
Notifications
You must be signed in to change notification settings - Fork 6.4k
docs: fix permission system documentation in agents section #7652
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: fix permission system documentation in agents section #7652
Conversation
|
The following comment was made by an LLM, it may be inaccurate: No duplicate PRs found |
d0fd373 to
0239fd0
Compare
| ``` | ||
|
|
||
| :::tip | ||
| Use pattern matching for commands with arguments. `"grep *"` allows `grep pattern file.txt`, while `"grep"` alone would block it. Commands like `git status` work for default behavior but require explicit permission (like `"git status*"`) when arguments are passed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think u can use git status * instead of git status*
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removed this one instead of the one in permissions.mdx, as I think it makes more sense there than in agents.mdx.
| Only analyze code and suggest changes. | ||
| ``` | ||
|
|
||
| :::tip |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
duplicate tip
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
kept this one and removed the duplicate one in agents.mdx
removed it from agents.mdx, as I think it makes more sense in the permissions page rather than in agents documentation page
What does this PR do?
Updates the agents section in the permissions documentation to reflect the new granular rules system. The previous examples showed mismatched patterns (e.g.,
"git status"without wildcards) that didn't properly demonstrate how pattern matching works for commands with arguments. The fix adds"grep *"examples to clearly demonstrate when pattern matching is essential, updates the explanatory tip to show both scenarios (commands that work without arguments vs. commands that require pattern matching).How did you verify your code works?
Ran the docs development server locally to verify the changes render correctly and the examples are properly formatted. The documentation now accurately reflects how the granular permission system works with clear examples showing when to use pattern matching for commands that accept arguments like
grep, versus commands that work with basic usage likegit status.