🧹 Daily Polish: nixos-ai — 2 doc fix(es)#2
Conversation
There was a problem hiding this comment.
Code Review
This pull request establishes the foundational documentation for the repository by introducing CLAUDE.md and README.md. These files outline the project's purpose as a system-level NixOS configuration for AI workloads, providing detailed installation, usage, and contribution guidelines. The review feedback points out a missing @AGENTS.md file reference and suggests a more secure approach to cloning the repository by avoiding sudo to maintain proper file ownership for Git operations.
| @@ -0,0 +1,41 @@ | |||
| # AI Agents Configuration | |||
|
|
|||
| @AGENTS.md | |||
| sudo git clone https://github.com/JacobPEvans/nixos-ai.git /etc/nixos | ||
| cd /etc/nixos |
There was a problem hiding this comment.
Cloning a repository with sudo results in the entire directory structure being owned by the root user. This requires the use of sudo for all subsequent Git operations (such as git pull or git status), which is a security and usability anti-pattern. It is recommended to clone the repository as a regular user and only use sudo for system-level deployment commands like nixos-rebuild.
| sudo git clone https://github.com/JacobPEvans/nixos-ai.git /etc/nixos | |
| cd /etc/nixos | |
| git clone https://github.com/JacobPEvans/nixos-ai.git ~/nixos-ai | |
| cd ~/nixos-ai |
Daily Polish auto-generated PR.
Checks before fix
1/5 passing.
Failing checks: README Quality, CLAUDE.md, Config Hygiene (renovate.json + .gitignore), Release Hygiene
Note: Config Hygiene and Release Hygiene are out of scope for daily-polish (not documentation files), so only README and CLAUDE.md were fixed.
Fixes applied
Content sourced from the author's own
feat/initial-importbranch.Checks after fix (self-verification)
Re-evaluated against the
chore/daily-polishbranch: improved from 1 → 3 passing.Generated by Daily Polish — prompt source: https://github.com/JacobPEvans/claude-code-routines/blob/main/routines/daily-polish.prompt.md