Skip to content

🧹 Daily Polish: nixos-ai — 2 doc fix(es)#2

Open
JacobPEvans-personal wants to merge 2 commits into
mainfrom
chore/daily-polish
Open

🧹 Daily Polish: nixos-ai — 2 doc fix(es)#2
JacobPEvans-personal wants to merge 2 commits into
mainfrom
chore/daily-polish

Conversation

@JacobPEvans-personal
Copy link
Copy Markdown
Member

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.

⚠️ Heads-up: PR #1 (feat/initial-import) is already open with the same files. This draft PR was created independently off the empty main branch. Whichever merges first will cause a conflict for the other — coordinate accordingly.

Fixes applied

  • README Quality: added comprehensive README (description, installation, usage, hosts table, conventions, validation, license)
  • CLAUDE.md: added CLAUDE.md with repo-specific guidance for AI agents

Content sourced from the author's own feat/initial-import branch.

Checks after fix (self-verification)

Re-evaluated against the chore/daily-polish branch: improved from 1 → 3 passing.

Check Before After
README Quality ❌ missing ✅ added (4603 bytes)
CLAUDE.md ❌ missing ✅ added (1552 bytes)
Repo Description
Config Hygiene ❌ (out of scope) ❌ (out of scope)
Release Hygiene ❌ (out of scope) ❌ (out of scope)

Generated by Daily Polish — prompt source: https://github.com/JacobPEvans/claude-code-routines/blob/main/routines/daily-polish.prompt.md

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread CLAUDE.md
@@ -0,0 +1,41 @@
# AI Agents Configuration

@AGENTS.md
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The reference @AGENTS.md points to a file that is not included in this pull request. If this file is missing from the repository, AI agents or tools that parse this file for context may fail or lack necessary information.

Comment thread README.md
Comment on lines +33 to +34
sudo git clone https://github.com/JacobPEvans/nixos-ai.git /etc/nixos
cd /etc/nixos
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

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.

Suggested change
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

@JacobPEvans-personal JacobPEvans-personal marked this pull request as ready for review May 24, 2026 16:25
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