docs: apply threat model markdown formatting #203

Merged
jwilger merged 4 commits from docs-threat-model-formatting into main 2026-05-15 10:42:47 -07:00
Owner

Summary

  • keep the pi-lens markdown formatting that was applied to docs/THREAT-MODEL.md after PR #202 was opened
  • no semantic threat-model content changes intended

Verification

  • git diff --check -- docs/THREAT-MODEL.md

Process follow-up

To work with pi-lens deferred formatting, PR creation should become a two-turn finalize flow: after any write/edit, stop before committing so pi-lens can run its agent_end formatting/autofix hooks; on the next turn, re-check toolchain_status/git diff, run verification, then commit, push, and open the PR from the post-hook working tree.

## Summary - keep the pi-lens markdown formatting that was applied to `docs/THREAT-MODEL.md` after PR #202 was opened - no semantic threat-model content changes intended ## Verification - `git diff --check -- docs/THREAT-MODEL.md` ## Process follow-up To work with pi-lens deferred formatting, PR creation should become a two-turn finalize flow: after any `write`/`edit`, stop before committing so pi-lens can run its `agent_end` formatting/autofix hooks; on the next turn, re-check `toolchain_status`/`git diff`, run verification, then commit, push, and open the PR from the post-hook working tree.
docs: apply threat model markdown formatting
All checks were successful
CI / Verify PR with nix flake check (pull_request) Successful in 3m35s
CI / Request auto_review semantic review (pull_request) Successful in 1s
CI / Build PR artifacts (no token) (pull_request) Successful in 2s
CI / Publish PR artifact packages (pull_request) Successful in 1s
auto_review auto_review: no findings
1f7c807f69
auto-review requested changes 2026-05-14 17:17:20 -07:00
Dismissed
auto-review left a comment

This PR applies markdown formatting to docs/THREAT-MODEL.md without altering the semantic content. The changes are purely stylistic, ensuring consistent formatting across the document. The PR appears safe to merge as it does not affect any functional code or logic.

Pre-merge checks

  • PR metadata quality: failed
  • Rationale: The title does not use an imperative verb and does not follow the conventional commit format. Additionally, the body does not provide a clear explanation of why the change is needed, as it mainly lists actions and verification steps without context.
  • Offending text: docs: apply threat model markdown formatting
This PR applies markdown formatting to `docs/THREAT-MODEL.md` without altering the semantic content. The changes are purely stylistic, ensuring consistent formatting across the document. The PR appears safe to merge as it does not affect any functional code or logic. ## Pre-merge checks - PR metadata quality: failed - Rationale: The title does not use an imperative verb and does not follow the conventional commit format. Additionally, the body does not provide a clear explanation of why the change is needed, as it mainly lists actions and verification steps without context. - Offending text: docs: apply threat model markdown formatting
Author
Owner

@auto-review wrote in jwilger/auto_review#203 (comment):

This PR applies markdown formatting to docs/THREAT-MODEL.md without altering the semantic content. The changes are purely stylistic, ensuring consistent formatting across the document. The PR appears safe to merge as it does not affect any functional code or logic.

Pre-merge checks

  • PR metadata quality: failed
  • Rationale: The title does not use an imperative verb and does not follow the conventional commit format. Additionally, the body does not provide a clear explanation of why the change is needed, as it mainly lists actions and verification steps without context.
  • Offending text: docs: apply threat model markdown formatting

This is invalid. The pr title and body both are perfectly adequate.

@auto-review wrote in https://git.johnwilger.com/jwilger/auto_review/pulls/203#issuecomment-8125: > This PR applies markdown formatting to `docs/THREAT-MODEL.md` without altering the semantic content. The changes are purely stylistic, ensuring consistent formatting across the document. The PR appears safe to merge as it does not affect any functional code or logic. > > ## [](#pre-merge-checks)Pre-merge checks > * PR metadata quality: failed > * Rationale: The title does not use an imperative verb and does not follow the conventional commit format. Additionally, the body does not provide a clear explanation of why the change is needed, as it mainly lists actions and verification steps without context. > * Offending text: docs: apply threat model markdown formatting This is invalid. The pr title and body both are perfectly adequate.
Owner

The changes in the pull request primarily consist of formatting adjustments in the THREAT-MODEL.md file. For example, the header for "Trust Boundaries" was aligned by changing the vertical bars and spaces for better readability (lines 52-88).

Key Changes:

  1. The formatting of the trust boundary and asset tables has been made more uniform and readable. For instance, the text alignment of the tables has been changed:

    • Original boundary lines on lines 52-83 were reformatted on lines 87-120.
    • Similar adjustments were made for the asset inventory on lines 92-119 to lines 123-134.
  2. There are also minor changes in the narrative text where bullet points have been replaced with underscore formatting for consistent style, such as in the "Attacker" and "Mitigation" sections (e.g., lines 111-311).

These changes do not alter the content or meaning but improve clarity and visual consistency throughout the document.

If you have specific lines or sections you want to inquire about further, feel free to ask!

The changes in the pull request primarily consist of formatting adjustments in the `THREAT-MODEL.md` file. For example, the header for "Trust Boundaries" was aligned by changing the vertical bars and spaces for better readability (lines 52-88). ### Key Changes: 1. The formatting of the trust boundary and asset tables has been made more uniform and readable. For instance, the text alignment of the tables has been changed: - Original boundary lines on lines 52-83 were reformatted on lines 87-120. - Similar adjustments were made for the asset inventory on lines 92-119 to lines 123-134. 2. There are also minor changes in the narrative text where bullet points have been replaced with underscore formatting for consistent style, such as in the "Attacker" and "Mitigation" sections (e.g., lines 111-311). These changes do not alter the content or meaning but improve clarity and visual consistency throughout the document. If you have specific lines or sections you want to inquire about further, feel free to ask!
Author
Owner

@auto-review re-review

@auto-review re-review
Owner

Queued a forced review at 1f7c807f69. This intentionally bypasses CI gating; watch the commit-status badge for progress.

Queued a forced review at 1f7c807f69bce4c9e4c1334c631d4615063775e6. This intentionally bypasses CI gating; watch the commit-status badge for progress.
auto-review requested changes 2026-05-14 17:22:11 -07:00
Dismissed
auto-review left a comment

This PR applies markdown formatting to docs/THREAT-MODEL.md to ensure consistent styling without altering the semantic content. The changes are purely stylistic and do not affect any functional code or logic, making it safe to merge.

Pre-merge checks

  • PR metadata quality: failed
  • Rationale: The title does not use an imperative verb and does not follow the conventional commit format. Additionally, the body does not provide a clear explanation of why the change is needed.
  • Offending text: docs: apply threat model markdown formatting
This PR applies markdown formatting to `docs/THREAT-MODEL.md` to ensure consistent styling without altering the semantic content. The changes are purely stylistic and do not affect any functional code or logic, making it safe to merge. ## Pre-merge checks - PR metadata quality: failed - Rationale: The title does not use an imperative verb and does not follow the conventional commit format. Additionally, the body does not provide a clear explanation of why the change is needed. - Offending text: docs: apply threat model markdown formatting
Merge branch 'main' into docs-threat-model-formatting
All checks were successful
CI / Verify PR with nix flake check (pull_request) Successful in 4m54s
CI / Request auto_review semantic review (pull_request) Successful in 3s
auto_review auto_review: no findings
CI / Build PR artifacts (no token) (pull_request) Successful in 2s
CI / Publish PR artifact packages (pull_request) Successful in 1s
97bb722200
auto-review left a comment

This pull request applies markdown formatting to docs/THREAT-MODEL.md without altering the semantic content. The changes are purely stylistic, ensuring consistent formatting across the document. The PR appears safe to merge as it does not affect any functional code or logic.

This pull request applies markdown formatting to `docs/THREAT-MODEL.md` without altering the semantic content. The changes are purely stylistic, ensuring consistent formatting across the document. The PR appears safe to merge as it does not affect any functional code or logic.
Merge branch 'main' into docs-threat-model-formatting
Some checks failed
CI / Verify PR with nix flake check (pull_request) Has been cancelled
CI / Request auto_review semantic review (pull_request) Has been cancelled
CI / Build PR artifacts (no token) (pull_request) Has been cancelled
CI / Publish PR artifact packages (pull_request) Has been cancelled
ed49a7f06b
jwilger scheduled this pull request to auto merge when all checks succeed 2026-05-15 10:29:34 -07:00
Merge branch 'main' into docs-threat-model-formatting
All checks were successful
CI / Verify PR with nix flake check (pull_request) Successful in 3m57s
CI / Request auto_review semantic review (pull_request) Successful in 1s
auto_review auto_review: 3 warnings
CI / Build PR artifacts (no token) (pull_request) Successful in 2s
CI / Publish PR artifact packages (pull_request) Successful in 1s
aa53f4720a
auto-review left a comment

This PR primarily focuses on enhancing git command safety and enforcing stricter execution policies by introducing new tools and modifying existing configurations. The changes appear well-structured, but the shift to deny all bash executions and the introduction of new safety checks should be thoroughly tested to ensure no disruptions in functionality.

Walkthrough

Key Changes:

  • Git Safety Enhancements: Introduced auto-review-git-safety.mjs to handle git command safety, ensuring only safe commands are executed.
  • Guardrails Update: Modified auto-review-guardrails.ts to block direct bash execution, requiring all operations to go through defined Pi tools.
  • Permission System: Updated pi-permission-system/config.json to deny all bash commands, enforcing stricter execution policies.
  • Environment Variable Handling: Improved error handling for environment variables in startup.rs to better manage non-Unicode values.
  • Testing: Added new tests in embedded_oci_env.rs and updated existing tests to cover the new safety mechanisms and execution policies.
This PR primarily focuses on enhancing git command safety and enforcing stricter execution policies by introducing new tools and modifying existing configurations. The changes appear well-structured, but the shift to deny all bash executions and the introduction of new safety checks should be thoroughly tested to ensure no disruptions in functionality. ## Walkthrough ### Key Changes: - **Git Safety Enhancements**: Introduced `auto-review-git-safety.mjs` to handle git command safety, ensuring only safe commands are executed. - **Guardrails Update**: Modified `auto-review-guardrails.ts` to block direct bash execution, requiring all operations to go through defined Pi tools. - **Permission System**: Updated `pi-permission-system/config.json` to deny all bash commands, enforcing stricter execution policies. - **Environment Variable Handling**: Improved error handling for environment variables in `startup.rs` to better manage non-Unicode values. - **Testing**: Added new tests in `embedded_oci_env.rs` and updated existing tests to cover the new safety mechanisms and execution policies.
Owner

🟡 Warning: The addition of spawnSync in auto-review-guardrails.ts should be reviewed for potential blocking behavior, as it can block the event loop. Consider using asynchronous alternatives if possible.

🟡 **Warning:** The addition of `spawnSync` in `auto-review-guardrails.ts` should be reviewed for potential blocking behavior, as it can block the event loop. Consider using asynchronous alternatives if possible.
Author
Owner

Filed a new tracking issue for this.

Filed a new tracking issue for this.
jwilger marked this conversation as resolved
Owner

🟡 Warning: Lines 620–759: The change to block all direct bash execution in auto-review-guardrails.ts is significant. Ensure that all necessary commands are covered by existing or new Pi tools to avoid breaking functionality.

🟡 **Warning:** **Lines 620–759:** The change to block all direct bash execution in `auto-review-guardrails.ts` is significant. Ensure that all necessary commands are covered by existing or new Pi tools to avoid breaking functionality.
jwilger marked this conversation as resolved
Owner

🟡 Warning: The change from allowing to denying all bash commands in pi-permission-system/config.json is a major shift. Verify that this does not inadvertently block necessary operations and that all required functionalities are available through other means.

🟡 **Warning:** The change from allowing to denying all bash commands in `pi-permission-system/config.json` is a major shift. Verify that this does not inadvertently block necessary operations and that all required functionalities are available through other means.
jwilger marked this conversation as resolved
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Slipstream/auto_review!203
No description provided.