Skip to content

docs: overhaul docs, trim AGENTS.md, expand BRANCHING.md, rewrite SECURITY.md - #23

Merged
aadil96 merged 18 commits into
mainfrom
fix/setup-script
Jul 11, 2026
Merged

docs: overhaul docs, trim AGENTS.md, expand BRANCHING.md, rewrite SECURITY.md#23
aadil96 merged 18 commits into
mainfrom
fix/setup-script

Conversation

@aadil96

@aadil96 aadil96 commented Jul 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • AGENTS.md: Trimmed from 150→74 lines. Moved git safety rules to BRANCHING.md. Used concise tables.
  • BRANCHING.md: Expanded with pre-change verification, safe ops whitelist, ask-before-doing list, rationale.
  • SECURITY.md: Replaced generic template with repo-specific policy (scope, key rules, deps, CI, reporting).
  • quality-gates.md: Updated for dotfiles context — ShellCheck + markdownlint gates.
  • troubleshooting.md: Added 7 entries (chezmoi init, mise, Brewfile, Tailscale, ShellCheck, markdownlint, externals, dev container).
  • opencode.json: Relaxed permission model, kept protected-branch guards.
  • Cleanup: Removed 4 empty doc stubs.

Review

Reviewed via code-review skill. Only findings were opencode.json permissions (user approved).

aadil96 added 17 commits June 12, 2026 23:19
Update setup
…URITY.md

- Trim AGENTS.md (150→74 lines) — move git safety to BRANCHING.md
- Expand BRANCHING.md with pre-change verification, safe ops, ask-before-doing, rationale
- Rewrite SECURITY.md with repo-specific policy (scope, rules, CI, reporting)
- Update quality-gates.md for dotfiles context (ShellCheck, markdownlint)
- Add 7 troubleshooting entries (chezmoi init, mise, Brewfile, Tailscale, CI, etc.)
- Remove 4 empty doc stubs (architecture, operations, references, workflows)
- Relax opencode.json permissions to allow workflow with protected-branch guards
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@what-the-diff

what-the-diff Bot commented Jul 11, 2026

Copy link
Copy Markdown

PR Summary

  • Enhanced .chezmoi.toml.tmpl support and scripting

    • Added a new environment variable DEVPOD to detect remote environments.
    • Enabled non-interactive scripting for collecting configuration values from environment variables, thereby improving automation.
    • Incorporated tailscale_authkey configuration variable for Tailscale integration.
  • Script additions and removal

    • Created a script to install and authenticate Tailscale.
    • Removed an obsolete script related to the aeos installation.
    • Introduced a new script for handling Homebrew bundle installations.
  • Settings and documentation improvements

    • Added a JSON settings file for managing permissions.
    • Updated documentation for clarity, highlighting quick commands, repo structure, enhanced security, practices around handling secrets and CI, and better error handling.
  • Homebrew and Shell updates

    • Added HOMEBREW_BUNDLE_FILE in .bashrc for consistent access to Brewfile.
    • Introduced a new Brewfile to manage Homebrew packages.
    • Updated dependencies, including new packages and version updates.
  • Plugin and Configuration enhancements

    • Updated, added, and modified plugins and their dependencies in lazy-lock.json.
    • Enhanced extras configuration with the addition of new plugins in lazyvim.json.
    • Refined Zsh configuration with added functionalities like completion support and a new function.
  • Permissions and Setup script improvements

    • Modified permissions settings for various commands, ensuring better control over critical commands.
    • Improved the setup script by adding checks, enhancing the configuration mode, and correctly structuring the ChezMoi application command for applying dotfiles.

@aadil96
aadil96 merged commit fee20ad into main Jul 11, 2026
3 checks passed
@aadil96
aadil96 deleted the fix/setup-script branch July 11, 2026 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant