Skip to content

Commit 3445fa1

Browse files
jacoponeclaude
andcommitted
docs: reorganize documentation structure and freshness cleanup
- Move docs to proper folders: THE_CLOSED_LOOP.md → architecture/, CI/CD docs → guides/ and integrations/ - Archive 71-day-old HN planning docs to archive/2025-10-planning/ - Archive draft automation docs (MCP, N8N, Google Drive) - Add SECURITY.md (standard for open source projects) - Add docs/README.md navigation index - Fix broken CORE_THESIS.md links - Update AI tools list (remove aider, add jules/droid/opencode) - Standardize tool count to 145 across documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent b0652fe commit 3445fa1

15 files changed

Lines changed: 174 additions & 11 deletions

CHANGELOG.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
status: active
33
created: 2024-06-01
4-
updated: 2025-10-08
4+
updated: 2025-12-18
55
type: reference
66
lifecycle: persistent
77
---
@@ -20,6 +20,8 @@ Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
2020
- `LICENSE` file (MIT) - previously only mentioned in README
2121
- `INSTALL.md` - comprehensive installation guide extracted from README
2222
- `CONTRIBUTING.md` - fork-friendly contribution guidelines
23+
- `SECURITY.md` - security policy (standard for open source projects)
24+
- `docs/README.md` - documentation navigation index
2325
- GitHub repository topics (16 tags for discoverability)
2426
- Demo GIF (`docs/assets/rebuild-demo.gif`) showing closed-loop workflow
2527

@@ -31,11 +33,18 @@ Format based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
3133
- Key Features table highlights permission learning, analytics, suggestions
3234
- Added "How It Works" section explaining claude-nixos-automation integration
3335
- Ecosystem table expanded with better descriptions of each repo's role
36+
- AI Tools list updated (removed aider, added jules/droid/opencode)
37+
- Tool count standardized to 145 across all documentation
3438

3539
### Documentation
3640
- Improved repository structure for GitHub discoverability
3741
- Added ecosystem table linking related repositories
3842
- Consolidated features into scannable tables
43+
- Moved `THE_CLOSED_LOOP.md` to `docs/architecture/`
44+
- Moved CI/CD docs to proper folders (`docs/guides/`, `docs/integrations/`)
45+
- Archived 71-day-old HN planning docs to `docs/archive/2025-10-planning/`
46+
- Archived draft automation docs (MCP, N8N, Google Drive)
47+
- Fixed broken link to non-existent `CORE_THESIS.md`
3948

4049
### Planned
4150
- User policies merge refactoring for claude-automation

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The intelligence comes from [claude-nixos-automation](https://github.com/jacopon
9898

9999
- **Claude Code** - Anthropic's CLI with auto-sync
100100
- **Cursor** - AI editor with quality gates
101-
- **Aider** - AI pair programming
101+
- **Gemini CLI / Jules** - Google's AI coding assistants
102102
- **Serena MCP** - Semantic code analysis
103103

104104
### Development Environment
@@ -125,7 +125,7 @@ The intelligence comes from [claude-nixos-automation](https://github.com/jacopon
125125

126126
**Quality**: `shellcheck`, `shfmt`, `ruff`, `semgrep`, `tokei`, `lizard`
127127

128-
**AI Tools**: `claude-code`, `cursor`, `aider`, `gemini-cli`, `serena`, `mcp-nixos`
128+
**AI Tools**: `claude-code`, `cursor`, `gemini-cli`, `jules`, `droid`, `opencode`, `serena`, `mcp-nixos`
129129

130130
See [`modules/core/packages.nix`](modules/core/packages.nix) for the complete list.
131131

SECURITY.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
status: active
3+
created: 2025-12-18
4+
updated: 2025-12-18
5+
type: reference
6+
lifecycle: persistent
7+
---
8+
9+
# Security Policy
10+
11+
## Supported Versions
12+
13+
This is a personal NixOS configuration. Security updates are applied via:
14+
- NixOS unstable channel (rolling updates)
15+
- Weekly `nix flake update` via automated maintenance
16+
17+
| Component | Version | Supported |
18+
|-----------|---------|-----------|
19+
| NixOS | 25.11 (unstable) | Yes |
20+
| Flake inputs | Latest | Yes |
21+
22+
## Reporting a Vulnerability
23+
24+
If you discover a security issue in this configuration:
25+
26+
1. **Do not open a public issue** for security vulnerabilities
27+
2. Email the maintainer directly or use GitHub's private vulnerability reporting
28+
3. Include:
29+
- Description of the vulnerability
30+
- Steps to reproduce
31+
- Potential impact
32+
- Suggested fix (if any)
33+
34+
### Response Timeline
35+
36+
- **Acknowledgment**: Within 48 hours
37+
- **Initial assessment**: Within 1 week
38+
- **Fix (if applicable)**: Depends on severity
39+
40+
## Security Considerations
41+
42+
### What This Repository Contains
43+
44+
- NixOS system configuration (declarative, reproducible)
45+
- Home Manager user configuration
46+
- Fish shell aliases and abbreviations
47+
- Development environment setup
48+
49+
### What This Repository Does NOT Contain
50+
51+
- Secrets, passwords, or API keys
52+
- SSH keys or certificates
53+
- Personal data or credentials
54+
55+
### Security Best Practices Used
56+
57+
1. **No hardcoded secrets** - All sensitive data via environment variables or external secret managers
58+
2. **Declarative configuration** - Full system state tracked in git
59+
3. **Reproducible builds** - Nix ensures build reproducibility
60+
4. **Minimal attack surface** - Only necessary packages installed
61+
5. **Regular updates** - Automated weekly flake updates
62+
63+
## Dependency Security
64+
65+
Dependencies are managed through Nix flakes with locked versions in `flake.lock`. Security updates are applied via:
66+
67+
```bash
68+
nix flake update # Updates all inputs
69+
./rebuild-nixos # Applies changes with safety checks
70+
```
71+
72+
## Contact
73+
74+
- GitHub Issues: For non-security bugs and feature requests
75+
- Private: Use GitHub's security advisory feature for vulnerabilities

docs/README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
status: active
3+
created: 2025-12-18
4+
updated: 2025-12-18
5+
type: reference
6+
lifecycle: persistent
7+
---
8+
9+
# Documentation Index
10+
11+
Navigation guide for all documentation in this repository.
12+
13+
## Quick Links
14+
15+
| Need | Go To |
16+
|------|-------|
17+
| Daily commands | [Common Tasks](guides/COMMON_TASKS.md) |
18+
| System architecture | [The Closed Loop](architecture/THE_CLOSED_LOOP.md) |
19+
| Tool configuration | [Tool Guides](#tool-guides) |
20+
| CI/CD setup | [CI/CD Quick Start](guides/CICD_QUICK_START.md) |
21+
22+
---
23+
24+
## Architecture
25+
26+
System design and how things work.
27+
28+
| Document | Description |
29+
|----------|-------------|
30+
| [The Closed Loop](architecture/THE_CLOSED_LOOP.md) | How system state auto-syncs to AI knowledge |
31+
| [Claude Orchestration](architecture/CLAUDE_ORCHESTRATION.md) | Multi-agent AI coordination system |
32+
33+
## Guides
34+
35+
Step-by-step instructions for common tasks.
36+
37+
| Document | Description |
38+
|----------|-------------|
39+
| [Common Tasks](guides/COMMON_TASKS.md) | Daily commands and workflows |
40+
| [GitHub Workflow](guides/GITHUB_WORKFLOW.md) | Git conventions and PR process |
41+
| [CI/CD Quick Start](guides/CICD_QUICK_START.md) | 5-minute CI/CD setup |
42+
| [CI/CD Implementation](guides/CICD_IMPLEMENTATION_GUIDE.md) | Full CI/CD implementation details |
43+
44+
## Tool Guides
45+
46+
Configuration and optimization for specific tools.
47+
48+
| Document | Description |
49+
|----------|-------------|
50+
| [Enhanced Tools](tools/enhanced-tools-guide.md) | Modern CLI tools deep dive |
51+
| [Fish Shell](tools/fish-smart-commands.md) | Fish abbreviations and smart commands |
52+
| [Kitty Terminal](tools/kitty-optimization-guide.md) | Terminal optimization guide |
53+
| [Yazi File Manager](tools/yazi-file-associations.md) | File associations and keybindings |
54+
55+
## Integrations
56+
57+
External tool integrations.
58+
59+
| Document | Description |
60+
|----------|-------------|
61+
| [Cursor AI Quality](integrations/CURSOR_AI_QUALITY_INTEGRATION.md) | AI editor quality gates |
62+
| [CI/CD Assessment](integrations/CICD_DEVOPS_ASSESSMENT.md) | DevOps maturity assessment |
63+
64+
## Archive
65+
66+
Historical documentation (kept for reference, may be outdated).
67+
68+
| Document | Description |
69+
|----------|-------------|
70+
| [2025-10 Planning](archive/2025-10-planning/) | HN launch planning docs |
71+
| [Documentation Audit](archive/DOCUMENTATION_AUDIT_2025-10-06.md) | October 2025 audit report |
72+
73+
---
74+
75+
## Related
76+
77+
- [README](../README.md) - Project overview
78+
- [INSTALL](../INSTALL.md) - Installation guide
79+
- [CONTRIBUTING](../CONTRIBUTING.md) - Contribution guidelines
80+
- [CHANGELOG](../CHANGELOG.md) - Version history
Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ def parse_packages(self, path: str) -> List[PackageInfo]:
160160
```python
161161
def generate(self) -> str:
162162
"""
163-
1. Parse packages.nix → get 122 tools
163+
1. Parse packages.nix → get 145 tools
164164
2. Parse base.nix → get 58 Fish abbreviations
165165
3. Render Jinja2 template with data
166166
4. Write to ~/.claude/CLAUDE.md
@@ -191,7 +191,7 @@ def generate(self) -> str:
191191
- cat → bat (ALWAYS use bat for file viewing, except when piping)
192192
- grep → rg (ALWAYS use ripgrep for text search)
193193

194-
## Available Command Line Tools (122)
194+
## Available Command Line Tools (145)
195195

196196
### AI Tools
197197
- aider - AI Development Enhancement Tools
@@ -218,7 +218,7 @@ def generate(self) -> str:
218218
```
219219

220220
**Purpose:** Claude reads this on session start and knows:
221-
- What tools are available (122 tools)
221+
- What tools are available (145 tools)
222222
- How to use them (descriptions + commands)
223223
- What substitutions to use (modern > legacy)
224224
- What abbreviations exist (Fish shell)
@@ -242,7 +242,7 @@ def generate(self) -> str:
242242

243243
## Project Structure
244244
- flake.nix - Main configuration entry point
245-
- modules/core/packages.nix - System-wide packages (122 tools)
245+
- modules/core/packages.nix - System-wide packages (145 tools)
246246
- modules/home-manager/base.nix - User configurations
247247

248248
## System Status
@@ -373,7 +373,7 @@ claude
373373
4. Hope you don't forget
374374
5. Hope you spell it correctly
375375
6. Hope you update when tool is removed
376-
7. Repeat for 122 tools 😩
376+
7. Repeat for 145 tools 😩
377377

378378
**Problems:**
379379
- ❌ Manual updates (tedious, error-prone)
@@ -621,7 +621,7 @@ def generate_claude_md(self, packages: List[Package]) -> str:
621621
```markdown
622622
# System-Level CLAUDE.md
623623

624-
## Available Command Line Tools (122)
624+
## Available Command Line Tools (145)
625625

626626
### AI Tools
627627
- `aider` - AI Development Enhancement Tools
@@ -718,7 +718,7 @@ def validate_claude_md(content: str) -> ValidationResult:
718718
|--------|--------|-----------|-------------|
719719
| **Time to document new tool** | 5-10 min | 0 seconds ||
720720
| **Documentation accuracy** | ~70% | 100% | +43% |
721-
| **Tools documented** | ~40 | 122 | +205% |
721+
| **Tools documented** | ~40 | 145 | +263% |
722722
| **Sync errors per month** | 10-15 | 0 | -100% |
723723
| **Maintenance time per month** | 2-3 hours | 0 seconds ||
724724

@@ -885,6 +885,5 @@ With it: AI always knows system state, zero maintenance, maximum productivity.
885885
---
886886

887887
**Learn more:**
888-
- [Core Thesis](CORE_THESIS.md) - Why this works
889888
- [Architecture](architecture/CLAUDE_ORCHESTRATION.md) - System design
890889
- [claude-nixos-automation](https://github.com/jacopone/claude-nixos-automation) - Source code

docs/planning/active/hn-post-and-readme-review/HN-POSSIBLE-STORY-1.md renamed to docs/archive/2025-10-planning/hn-post-and-readme-review/HN-POSSIBLE-STORY-1.md

File renamed without changes.

docs/planning/active/hn-post-and-readme-review/HN-POSSIBLE-STORY-2.md renamed to docs/archive/2025-10-planning/hn-post-and-readme-review/HN-POSSIBLE-STORY-2.md

File renamed without changes.

docs/planning/active/hn-post-and-readme-review/HN_LAUNCH_PLAN.md renamed to docs/archive/2025-10-planning/hn-post-and-readme-review/HN_LAUNCH_PLAN.md

File renamed without changes.

docs/planning/active/hn-post-and-readme-review/README_REFACTORING_STRATEGY.md renamed to docs/archive/2025-10-planning/hn-post-and-readme-review/README_REFACTORING_STRATEGY.md

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)