Skip to content

[docs] Add permission handling section to getting-started guide#20

Closed
github-actions[bot] wants to merge 1 commit intomainfrom
docs/permission-handling-getting-started-21d352c1dc80f01a
Closed

[docs] Add permission handling section to getting-started guide#20
github-actions[bot] wants to merge 1 commit intomainfrom
docs/permission-handling-getting-started-21d352c1dc80f01a

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Documentation Updates - February 19, 2026

This PR enhances the getting-started guide to cover the deny-by-default permission model introduced in PR #18 (upstream PR #509 sync).

Features Documented

Changes Made

  • Added new Step 5: Handle Permissions (Deny-by-Default) to doc/getting-started.md
    • Explains the deny-by-default security model
    • Shows approve-all usage for development/trusted environments
    • Demonstrates custom permission handler implementation
    • Links to permission_bash.clj example and API reference
  • Renumbered subsequent steps (Step 5→6, Step 6→7)
  • Updated CHANGELOG.md with documentation changes

Why This Matters

PR #18 introduced the deny-by-default permission model as a breaking change. While the API reference, examples README, and main README were updated, the getting-started guide lacked coverage of this critical security feature. New users following the tutorial would encounter permission denials when using tools like bash or file operations without understanding why or how to handle them.

Validation

  • ✅ Code examples parse correctly (validated with clojure -)
  • ✅ All internal links verified:
    • ../examples/permission_bash.clj exists
    • ./reference/API.md#permission-handling anchor exists
  • ⚠️ Full validation pending (network issues prevented bb validate-docs from running)

Merged PRs Referenced

Related Upstream Changes


Note: This PR was automatically generated by the daily documentation updater workflow. Human review is recommended before merging.

AI generated by Daily Documentation Updater

  • expires on Feb 20, 2026, 1:28 PM UTC

- Add Step 5 covering deny-by-default permission model
- Show approve-all usage for development/trusted environments
- Demonstrate custom permission handler implementation
- Link to permission_bash.clj example and API reference
- Renumber subsequent steps (Step 5->6, Step 6->7)

Updates CHANGELOG.md with documentation changes.

Addresses documentation gap identified in PR #18 review - the getting-started
guide now properly introduces users to permission handling, which is critical
for sessions using bash, file operations, or other restricted tools.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Feb 19, 2026
@github-actions github-actions Bot enabled auto-merge February 19, 2026 13:28
@github-actions
Copy link
Copy Markdown
Contributor Author

This pull request was automatically closed because it expired on 2026-02-20T13:28:31.711Z.

Closed by Workflow

@github-actions github-actions Bot closed this Feb 20, 2026
auto-merge was automatically disabled February 20, 2026 13:44

Pull request was closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants