Skip to content

Commit 4f30bb4

Browse files
authored
Merge pull request #14 from project-codeguard/feature/updating-index-page
Revise terminology and enhance clarity in documentation
2 parents 354f0cd + 8036eb8 commit 4f30bb4

File tree

1 file changed

+10
-36
lines changed

1 file changed

+10
-36
lines changed

docs/index.md

Lines changed: 10 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,32 @@
1-
# Project CodeGuard: Security Rules for AI Coding Assistants
1+
# Project CodeGuard: Security Rules for AI Coding Agents
22

3-
Project CodeGuard is an open-source, model-agnostic security framework that embeds secure-by-default practices into AI coding workflows. It provides comprehensive security rules that guide AI assistants to generate more secure code automatically.
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.
44

55
## Why Project CodeGuard?
66

7-
AI-powered IDEs and coding agents are transforming software development, but this speed can introduce security gaps:
7+
AI coding agents are transforming software engineering, but this speed can introduce security vulnerabilities. Is your AI coding agent implementation introducing security vulnerabilities?
88

99
- ❌ Skipping input validation
1010
- ❌ Hardcoding secrets and credentials
1111
- ❌ Using weak cryptographic algorithms
1212
- ❌ Relying on unsafe functions
1313
- ❌ Missing authentication/authorization checks
14+
- ❌ Missing any other security best practice
1415

15-
**Project CodeGuard solves this by embedding security best practices directly into AI coding workflows.**
16+
Project CodeGuard solves this by embedding security best practices directly into AI coding agent workflows.
1617

17-
## Key Features
18+
**During and After Code Generation.**
1819

19-
<div class="grid cards" markdown>
20+
These rules can be used for:
21+
- preventing vulnerabilities from being introduced during code generation
22+
- automated code review by AI agents
2023

21-
- :material-shield-check: **Comprehensive Coverage**
22-
23-
---
24-
25-
Security rules covering cryptography, input validation, authentication, authorization, and more
26-
27-
- :material-robot: **Model-Agnostic**
28-
29-
---
30-
31-
Works with any AI coding assistant - Cursor, Windsurf, GitHub Copilot, and more
32-
33-
- :material-speedometer: **Zero Friction**
34-
35-
---
36-
37-
No developer overhead or workflow changes required - works transparently in the background
38-
39-
- :material-open-source-initiative: **Open Source**
40-
41-
---
42-
43-
Apache 2.0 licensed, community-driven, and extensible for your specific needs
44-
45-
</div>
4624

4725
## Security Coverage
4826

4927
Our rules cover essential security domains:
5028

51-
- **🔐 Cryptography**: Safe algorithms (AES-256, SHA-256+), secure key management, certificate validation
29+
- **🔐 Cryptography**: Safe algorithms (including post-quantum cryptography), secure key management, certificate validation
5230
- **🛡️ Input Validation**: SQL injection prevention, XSS protection, command injection defense
5331
- **🔑 Authentication**: MFA best practices, OAuth/OIDC, secure session management
5432
- **⚡ Authorization**: RBAC/ABAC, access control, IDOR prevention
@@ -81,7 +59,3 @@ Get started in minutes:
8159
- **💬 Discussions**: [Join the conversation](https://github.com/project-codeguard/rules/discussions)
8260
- **🤝 Contributing**: [Learn how to contribute](https://github.com/project-codeguard/rules/blob/main/CONTRIBUTING.md)
8361

84-
## License
85-
86-
Project CodeGuard is released under the [Apache License](https://github.com/project-codeguard/rules/blob/main/LICENSE).
87-

0 commit comments

Comments
 (0)