Skip to content

Commit a0ff358

Browse files
authored
docs: Update repository references to cosai-oasis/project-codeguard (#16)
Update all documentation references from the old repository (project-codeguard/rules) to the new CoSAI OASIS repository (cosai-oasis/project-codeguard). Changes include: - GitHub URLs (releases, issues, discussions, contributing) - Git clone commands - Plugin marketplace commands - Skill installer commands - JSON configuration examples - File path references Affected files: - docs/index.md (6 references) - docs/getting-started.md (10 references) - docs/faq.md (9 references) - docs/claude-code-skill-plugin.md (10 references)
1 parent f2525df commit a0ff358

4 files changed

Lines changed: 35 additions & 35 deletions

File tree

docs/claude-code-skill-plugin.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Agent Skills are model-invoked capabilities that Claude autonomously uses based
2121

2222
1. **Add the Project CodeGuard marketplace:**
2323
```bash
24-
/plugin marketplace add project-codeguard/rules
24+
/plugin marketplace add cosai-oasis/project-codeguard
2525
```
2626

2727
2. **Install the security plugin:**
@@ -135,7 +135,7 @@ For organizations, deploy CodeGuard to all developers automatically:
135135
1. Add to your project's `.claude/settings.json`:
136136
```json
137137
{
138-
"marketplaces": [{"source": "project-codeguard/rules"}],
138+
"marketplaces": [{"source": "cosai-oasis/project-codeguard"}],
139139
"plugins": [
140140
{
141141
"name": "codeguard-security",
@@ -281,7 +281,7 @@ Look for `codeguard-security@project-codeguard` and note the version number.
281281
If you're contributing to Project CodeGuard or need to rebuild the plugin:
282282

283283
```bash
284-
cd /path/to/project-codeguard/rules
284+
cd /path/to/cosai-oasis/project-codeguard
285285

286286
# Regenerate the Claude Code plugin (always uses core rules only)
287287
uv run python src/convert_to_ide_formats.py
@@ -331,7 +331,7 @@ Use CodeGuard rules to guide the architecture.
331331
### File Structure
332332

333333
```
334-
project-codeguard/rules/
334+
cosai-oasis/project-codeguard/
335335
├── .claude-plugin/
336336
│ ├── plugin.json # Plugin metadata
337337
│ └── marketplace.json # Marketplace catalog
@@ -378,9 +378,9 @@ When you write or review code, Claude follows this workflow:
378378

379379
Found an issue with the plugin or want to improve it?
380380

381-
1. **Report issues**: [GitHub Issues](https://github.com/project-codeguard/rules/issues)
382-
2. **Suggest rules**: [GitHub Discussions](https://github.com/project-codeguard/rules/discussions)
383-
3. **Contribute**: [Contributing Guide](https://github.com/project-codeguard/rules/blob/main/CONTRIBUTING.md)
381+
1. **Report issues**: [GitHub Issues](https://github.com/cosai-oasis/project-codeguard/issues)
382+
2. **Suggest rules**: [GitHub Discussions](https://github.com/cosai-oasis/project-codeguard/discussions)
383+
3. **Contribute**: [Contributing Guide](https://github.com/cosai-oasis/project-codeguard/blob/main/CONTRIBUTING.md)
384384

385385
## Version History
386386

@@ -400,9 +400,9 @@ Found an issue with the plugin or want to improve it?
400400
## Resources
401401

402402
- **Project Website**: [https://project-codeguard.org](https://project-codeguard.org)
403-
- **GitHub Repository**: [https://github.com/project-codeguard/rules](https://github.com/project-codeguard/rules)
403+
- **GitHub Repository**: [https://github.com/cosai-oasis/project-codeguard](https://github.com/cosai-oasis/project-codeguard)
404404
- **Documentation**: [https://project-codeguard.org/getting-started/](https://project-codeguard.org/getting-started/)
405-
- **Issue Tracker**: [https://github.com/project-codeguard/rules/issues](https://github.com/project-codeguard/rules/issues)
405+
- **Issue Tracker**: [https://github.com/cosai-oasis/project-codeguard/issues](https://github.com/cosai-oasis/project-codeguard/issues)
406406

407407
## License
408408

@@ -414,7 +414,7 @@ Found an issue with the plugin or want to improve it?
414414
Need help? We're here for you:
415415

416416
1. **Documentation**: Start with [Getting Started Guide](https://project-codeguard.org/getting-started/)
417-
2. **Community**: Join [GitHub Discussions](https://github.com/project-codeguard/rules/discussions)
418-
3. **Issues**: Report bugs via [GitHub Issues](https://github.com/project-codeguard/rules/issues)
417+
2. **Community**: Join [GitHub Discussions](https://github.com/cosai-oasis/project-codeguard/discussions)
418+
3. **Issues**: Report bugs via [GitHub Issues](https://github.com/cosai-oasis/project-codeguard/issues)
419419

420420

docs/faq.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ This FAQ document provides clear, concise answers to help developers seamlessly
88

99
## Q: Where can I access the rules?
1010

11-
**A:** You can access the rules in the [Project CodeGuard GitHub repository](https://github.com/project-codeguard/rules). The latest stable release is available on the [releases page](https://github.com/project-codeguard/rules/releases).
11+
**A:** You can access the rules in the [Project CodeGuard GitHub repository](https://github.com/cosai-oasis/project-codeguard). The latest stable release is available on the [releases page](https://github.com/cosai-oasis/project-codeguard/releases).
1212

1313
---
1414

1515
## Q: How can I use the rules in Windsurf, Cursor, or GitHub Copilot?
1616

1717
**A:** Detailed installation instructions are available in our [Getting Started guide](getting-started.md). In summary:
1818

19-
1. Download the latest release from the [releases page](https://github.com/project-codeguard/rules/releases)
19+
1. Download the latest release from the [releases page](https://github.com/cosai-oasis/project-codeguard/releases)
2020
2. Extract the archive and copy the IDE-specific rules to your project:
2121
- **Cursor**: Copy `.cursor/` directory to your project root
2222
- **Windsurf**: Copy `.windsurf/` directory to your project root
@@ -50,7 +50,7 @@ This FAQ document provides clear, concise answers to help developers seamlessly
5050

5151
## Q: How can I use the rules in my own AI agent?
5252

53-
**A:** You can use the rules in your own AI agent by creating a custom ruleset. You can create a custom ruleset by creating a new file in the `.cursor/rules`, `.windsurf/rules`, `.github/instructions`, or `.agent/rules` directories and adding the rules you want to apply. You can also use the `project-codeguard/rules` repository as a template to create your own ruleset.
53+
**A:** You can use the rules in your own AI agent by creating a custom ruleset. You can create a custom ruleset by creating a new file in the `.cursor/rules`, `.windsurf/rules`, `.github/instructions`, or `.agent/rules` directories and adding the rules you want to apply. You can also use the `cosai-oasis/project-codeguard` repository as a template to create your own ruleset.
5454

5555
---
5656

@@ -85,7 +85,7 @@ Once hidden files are visible, you can copy the appropriate directory (`.cursor/
8585
**A:** Yes! Install the Project CodeGuard Claude Code plugin (Agent Skill) and Claude will apply the security rules automatically while you code.
8686

8787
```bash
88-
/plugin marketplace add project-codeguard/rules
88+
/plugin marketplace add cosai-oasis/project-codeguard
8989
/plugin install codeguard-security@project-codeguard
9090
```
9191

@@ -96,7 +96,7 @@ For team/repo defaults, add the plugin in `.claude/settings.json` so it’s enab
9696

9797
**A:** You can report problems, successes, or suggest enhancements to any of the rules by:
9898

99-
1. **Creating a GitHub issue**: [Open an issue here](https://github.com/project-codeguard/rules/issues)
99+
1. **Creating a GitHub issue**: [Open an issue here](https://github.com/cosai-oasis/project-codeguard/issues)
100100
2. **Provide details**: Include which rule(s) are affected, the issue you encountered, and your suggested improvement
101101
3. **Be specific**: If reporting a bug, include steps to reproduce and example code if possible
102102

@@ -113,7 +113,7 @@ We welcome all feedback - whether it's a bug report, success story, or enhanceme
113113
3. **Participating in discussions**: Share your experience and help other users
114114
4. **Improving documentation**: Help make our docs clearer and more comprehensive
115115

116-
See [CONTRIBUTING.md](https://github.com/project-codeguard/rules/blob/main/CONTRIBUTING.md) for detailed guidelines on our contribution process.
116+
See [CONTRIBUTING.md](https://github.com/cosai-oasis/project-codeguard/blob/main/CONTRIBUTING.md) for detailed guidelines on our contribution process.
117117

118118
---
119119

@@ -127,8 +127,8 @@ See [CONTRIBUTING.md](https://github.com/project-codeguard/rules/blob/main/CONTR
127127

128128
**Can't find your answer?**
129129

130-
- [Open an issue](https://github.com/project-codeguard/rules/issues) with your question
131-
- [Start a discussion](https://github.com/project-codeguard/rules/discussions) to chat with the community
130+
- [Open an issue](https://github.com/cosai-oasis/project-codeguard/issues) with your question
131+
- [Start a discussion](https://github.com/cosai-oasis/project-codeguard/discussions) to chat with the community
132132

133133

134134

docs/getting-started.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Before you begin, familiarize yourself with how rules work in your IDE:
4040

4141
### Option 1: Download Pre-built Rules (Recommended)
4242

43-
1. **Download**: Visit the [Releases page](https://github.com/project-codeguard/rules/releases) and download the IDE-specific ZIP file:
43+
1. **Download**: Visit the [Releases page](https://github.com/cosai-oasis/project-codeguard/releases) and download the IDE-specific ZIP file:
4444
- `ide-rules-all.zip` - All IDE formats (recommended for teams using multiple tools)
4545
- `ide-rules-cursor.zip` - Cursor only
4646
- `ide-rules-windsurf.zip` - Windsurf only
@@ -69,7 +69,7 @@ Claude Code uses a plugin system instead of manual file installation:
6969

7070
```bash
7171
# Add the Project CodeGuard marketplace
72-
/plugin marketplace add project-codeguard/rules
72+
/plugin marketplace add cosai-oasis/project-codeguard
7373

7474
# Install the security plugin
7575
/plugin install codeguard-security@project-codeguard
@@ -87,7 +87,7 @@ OpenAI Codex uses [agent skills](https://agentskills.io/) to extend capabilities
8787
To install Project CodeGuard as a Codex skill, open Codex and use the built-in skill installer:
8888

8989
```
90-
$skill-installer install from https://github.com/project-codeguard/rules/tree/main/skills/software-security
90+
$skill-installer install from https://github.com/cosai-oasis/project-codeguard/tree/main/skills/software-security
9191
```
9292

9393
Alternatively, you can manually clone the skill to your project:
@@ -96,7 +96,7 @@ Alternatively, you can manually clone the skill to your project:
9696
# Clone to your project's .codex/skills directory
9797
mkdir -p .codex/skills
9898
cd .codex/skills
99-
git clone https://github.com/project-codeguard/rules.git temp
99+
git clone https://github.com/cosai-oasis/project-codeguard.git temp
100100
mv temp/skills/software-security ./
101101
rm -rf temp
102102

@@ -114,7 +114,7 @@ If you want to customize or contribute to the rules:
114114

115115
```bash
116116
# Clone the repository
117-
git clone https://github.com/project-codeguard/rules.git
117+
git clone https://github.com/cosai-oasis/project-codeguard.git
118118
cd rules
119119

120120
# Install dependencies (requires Python 3.11+)
@@ -197,8 +197,8 @@ To verify the rules are working:
197197

198198
- **Review Rules**: Explore the security rules in your IDE's rules directory
199199
- **Test Integration**: Generate some code and see the security guidance in action
200-
- **Share Feedback**: Help us improve by [opening an issue](https://github.com/project-codeguard/rules/issues)
201-
- **Contribute**: See [CONTRIBUTING.md](https://github.com/project-codeguard/rules/blob/main/CONTRIBUTING.md) to contribute new rules or improvements
200+
- **Share Feedback**: Help us improve by [opening an issue](https://github.com/cosai-oasis/project-codeguard/issues)
201+
- **Contribute**: See [CONTRIBUTING.md](https://github.com/cosai-oasis/project-codeguard/blob/main/CONTRIBUTING.md) to contribute new rules or improvements
202202

203203
!!! success "You're Ready!"
204204
Project CodeGuard is now protecting your development workflow. The security rules will automatically guide AI assistants to generate more secure code.
@@ -220,11 +220,11 @@ The rules have minimal performance impact, but if you experience issues:
220220

221221
- **Reduce rule count**: Start with core rules (cryptography, input validation, authentication)
222222
- **Combine rules**: Merge related rules into fewer files
223-
- **Report issues**: Let us know via [GitHub Issues](https://github.com/project-codeguard/rules/issues)
223+
- **Report issues**: Let us know via [GitHub Issues](https://github.com/cosai-oasis/project-codeguard/issues)
224224

225225
## Getting Help
226226

227227
- **Documentation**: You're reading it! Check the [FAQ](faq.md) for common questions
228-
- **GitHub Issues**: [Report bugs or ask questions](https://github.com/project-codeguard/rules/issues)
229-
- **Discussions**: [Join the community discussion](https://github.com/project-codeguard/rules/discussions)
228+
- **GitHub Issues**: [Report bugs or ask questions](https://github.com/cosai-oasis/project-codeguard/issues)
229+
- **Discussions**: [Join the community discussion](https://github.com/cosai-oasis/project-codeguard/discussions)
230230

docs/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Project CodeGuard: Security Rules for AI Coding Agents
22

3-
[Project CodeGuard](https://github.com/project-codeguard/rules) is an open-source, model-agnostic security framework that embeds secure-by-default practices into AI coding agent workflows. It provides comprehensive security rules that guide AI assistants to generate more secure code automatically.
3+
[Project CodeGuard](https://github.com/cosai-oasis/project-codeguard) is an open-source, model-agnostic security framework that embeds secure-by-default practices into AI coding agent workflows. It provides comprehensive security rules that guide AI assistants to generate more secure code automatically.
44

55
## Why Project CodeGuard?
66

@@ -41,12 +41,12 @@ Our rules cover essential security domains:
4141

4242
Get started in minutes:
4343

44-
1. **Download the rules** from our [releases page](https://github.com/project-codeguard/rules/releases)
44+
1. **Download the rules** from our [releases page](https://github.com/cosai-oasis/project-codeguard/releases)
4545
2. **Copy to your project** - Place IDE-specific rules in your repository
4646
3. **Start coding** - AI assistants will automatically follow security best practices
4747

4848
[Get Started →](getting-started.md){ .md-button .md-button--primary }
49-
[View on GitHub :material-github:](https://github.com/project-codeguard/rules){ .md-button }
49+
[View on GitHub :material-github:](https://github.com/cosai-oasis/project-codeguard){ .md-button }
5050

5151
## How It Works
5252

@@ -57,9 +57,9 @@ Get started in minutes:
5757

5858
## Community
5959

60-
- **📋 Issues**: [Report bugs or request features](https://github.com/project-codeguard/rules/issues)
61-
- **💬 Discussions**: [Join the conversation](https://github.com/project-codeguard/rules/discussions)
62-
- **🤝 Contributing**: [Learn how to contribute](https://github.com/project-codeguard/rules/blob/main/CONTRIBUTING.md)
60+
- **📋 Issues**: [Report bugs or request features](https://github.com/cosai-oasis/project-codeguard/issues)
61+
- **💬 Discussions**: [Join the conversation](https://github.com/cosai-oasis/project-codeguard/discussions)
62+
- **🤝 Contributing**: [Learn how to contribute](https://github.com/cosai-oasis/project-codeguard/blob/main/CONTRIBUTING.md)
6363

6464
## Note
6565

0 commit comments

Comments
 (0)