Skip to content

Commit ffe81d2

Browse files
authored
Merge pull request #35 from project-codeguard/develop
docs: Add FAQ to address empty directory after downloading release
2 parents 59ff939 + bbb42a2 commit ffe81d2

File tree

3 files changed

+28
-2
lines changed

3 files changed

+28
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Get started in minutes:
4848
2. **Copy to your project** - Place AI agent and IDE specific rules in your repository
4949
3. **Start coding** - AI assistants will automatically follow security best practices
5050

51-
- Additional details in the [Get Started →](getting-started.md)
51+
- Additional details in the [Get Started →](https://project-codeguard.org/getting-started/)
5252

5353

5454
## How It Works

docs/faq.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,32 @@ This FAQ document provides clear, concise answers to help developers seamlessly
2525

2626
---
2727

28+
## Q: Why does the downloaded release folder appear empty?
29+
30+
**A:** After downloading and extracting the release, the folders may appear empty because the rule directories (`.cursor/`, `.windsurf/`, `.github/`) start with a dot (`.`) and are hidden by default on most operating systems.
31+
32+
**To show hidden files:**
33+
34+
=== "macOS"
35+
36+
In Finder, navigate to the extracted `ide_rules/` folder and press ++cmd+shift+period++ to toggle the visibility of hidden files. You should now see the `.cursor/`, `.windsurf/`, and `.github/` directories.
37+
38+
=== "Windows"
39+
40+
In File Explorer:
41+
42+
1. Navigate to the extracted `ide_rules/` folder
43+
2. Click on the **View** tab in the ribbon
44+
3. Check the **Hidden items** checkbox
45+
46+
=== "Linux"
47+
48+
In your file manager, press ++ctrl+h++ to toggle hidden files, or use `ls -la` in the terminal to view all files including hidden ones.
49+
50+
Once hidden files are visible, you can copy the appropriate directory (`.cursor/`, `.windsurf/`, or `.github/`) to your project root.
51+
52+
---
53+
2854
## Q: Can I use this with Claude Code?
2955

3056
**A:** Yes! Claude Code automatically reads and follows instructions from a `CLAUDE.md` file in your project root. To use Project CodeGuard rules with Claude Code you can point to the Project CodeGuard rules in your `CLAUDE.md` file.

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ AI coding agents are transforming software engineering, but this speed can intro
1515

1616
Project CodeGuard solves this by embedding security best practices directly into AI coding agent workflows.
1717

18-
**Before,During, and After Code Generation.**
18+
**Before, During, and After Code Generation.**
1919

2020
Project CodeGuard can be used **before**, **during** and **after** code generation. They can be used at the AI agent planning phase or for initial specification-driven engineering tasks. Project CodeGuard rules can also be used to prevent vulnerabilities from being introduced during code generation. They can also be used by automated code-review AI agents.
2121

0 commit comments

Comments
 (0)