Skip to content

Commit

Permalink
chore(docs): Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
simar7 committed Nov 2, 2023
1 parent 7fcb7b1 commit b507aa5
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions ARCHITECTURE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Architecture

This document aims to answer the question *Where is the code that does X?*

## Project Layout

The directory structure is broken down as follows:

- `cmd/` - These CLI tools are primarily used during development for end-to-end testing without needing to pull the library into trivy/tfsec etc.
- `rules` - All of the rules and policies are defined in this directory.
- `pkg/spec` - Logic to handle standardized specs such as CIS.
- `pkg/rules` - This package exposes internal rules, and imports them accordingly (see _rules.go_).
- `test` - Integration tests and other high-level tests that require a full build of the project.
- `scripts` - Usefule generation scripts for bundle generation and verification purposes.

0 comments on commit b507aa5

Please sign in to comment.