v1-prerelease docs

xfhg · Sep 12, 2024 · 0d6c4ed · 0d6c4ed
1 parent 0e3ff6c
commit 0d6c4ed
Show file tree

Hide file tree

Showing 10 changed files with 596 additions and 66 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -15,57 +15,64 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Code', link: 'https://github.com/xfhg/intercept' },
-      { text: 'Documentation', link: '/docs/tbd' },
-      { text: 'Features', link: '/docs/tbd' },
+      { text: 'Documentation', link: '/docs/architecture' },
+      { text: 'Basics', link: '/docs/basics' },
       { text: 'Latest Release', link: 'https://github.com/xfhg/intercept/releases' }
     ],
     // head: [['link', { rel: 'icon', href: '/intercept-icon.svg' }]],
     logo: '/intercept-icon.svg',
     sidebar: [
+      {
+        text: 'Architecture',
+        items: [
+          { text: 'Workflow', link: '/docs/architecture' },
+          { text: 'Basic Concepts', link: '/docs/basics' },
+          { text: 'Features', link: '/docs/features' },
+
+        ]
+      },
       {
         text: 'Getting Started',
         items: [
-          { text: 'Architecture', link: '/docs/architecture' },
           { text: 'Platform Build', link: '/docs/platform-build' },
           { text: 'Docker QuickStart', link: '/docs/docker-quickstart' },
           { text: 'Sandbox Playground', link: '/docs/sandbox' },
         ]
       },
-
       {
         text: 'Policy Features',
         items: [
-          { text: 'Schema', link: '/docs/policy-schema' },
-          { text: 'Enforcement Levels', link: '/docs/enforcement' },
-          { text: 'Patching', link: '/docs/patching' },
-          { text: 'Monitoring', link: '/docs/monitoring' },
+          { text: 'Schema', link: '/docs/tbd' },
+          { text: 'Enforcement Levels', link: '/docs/tbd' },
+          { text: 'Patching', link: '/docs/tbd' },
+          { text: 'Monitoring', link: '/docs/tbd' },
         ]
       },
 
       {
         text: 'Policy Types',
         items: [
-          { text: 'SCAN ', link: '/docs/policy-scan-regex' },
-          { text: 'ASSURE ', link: '/docs/policy-assure-regex' },
-          { text: 'ASSURE - REGO ', link: '/docs/policy-assure-rego' },
-          { text: 'ASSURE - TYPE ', link: '/docs/policy-assure-filetype' },
-          { text: 'ASSURE - API ', link: '/docs/policy-assure-api' },
-          { text: 'RUNTIME ', link: '/docs/policy-runtime' },
+          { text: 'SCAN ', link: '/docs/tbd' },
+          { text: 'ASSURE ', link: '/docs/tbd' },
+          { text: 'ASSURE - REGO ', link: '/docs/tbd' },
+          { text: 'ASSURE - TYPE ', link: '/docs/tbd' },
+          { text: 'ASSURE - API ', link: '/docs/tbd' },
+          { text: 'RUNTIME ', link: '/docs/tbd' },
         ]
       },
       {
         text: 'INTERCEPT AUDIT',
         items: [
-          { text: 'Compliance Reporting', link: '/docs/compliance-report' },
-          { text: 'Feature Flags', link: '/docs/feature-flags' },
+          { text: 'Compliance Reporting', link: '/docs/tbd' },
+          { text: 'Feature Flags', link: '/docs/tbd' },
         ]
       },
       {
         text: 'INTERCEPT OBSERVE',
         items: [
-          { text: 'Setup', link: '/docs/intercept-observe' },
-          { text: 'Runtime Daemon', link: '/docs/runtime-observe' },
-          { text: 'Integration Webhooks', link: '/docs/hooks' }
+          { text: 'Setup', link: '/docs/tbd' },
+          { text: 'Runtime Daemon', link: '/docs/tbd' },
+          { text: 'Integration Webhooks', link: '/docs/tbd' }
         ]
       },
       {
@@ -80,7 +87,7 @@ export default defineConfig({
       { icon: 'github', link: 'https://github.com/xfhg/intercept' }
     ],
     footer: {
-      message: 'Released under the <a href="https://github.com/xfhg/intercept/blob/master/LICENSE">EUPL-1.2 License</a>',
+      message: 'Released under the <a href="https://github.com/xfhg/intercept/blob/master/LICENSE.md">EUPL-1.2 License</a>',
       copyright: 'Copyright © 2018-202X - <a href="https://github.com/xfhg">Flávio HG</a>'
     }
   },

diff --git a/docs/docs/architecture.md b/docs/docs/architecture.md
@@ -7,9 +7,8 @@ Intercept provides an industry-standard, policy-based approach to security and c
 
 ---
 
-::: tip TBD
-INSERT ARCH DIAGRAM HERE
-:::
+
+ <img alt="Intercept Arch" src="/arch.png">
 
 ---
 
@@ -19,53 +18,38 @@ To accomplish a thorough scan of your codebase or system state, the INTERCEPT Po
 
 <br><br>
 
-```shell
-Usage:
-  intercept [command]
-
-Available Commands:
-  audit       Run an optimized audit through all loaded policies
-  completion  Generate the autocompletion script for the specified shell
-  help        Help about any command
-  observe     Observe and trigger realtime policies based on schedules or active path monitoring
-  sys         Test intercept embedded core binaries
-  version     Print the build info of intercept
 
-Flags:
-      --experimental        Enables unreleased experimental features
-  -h, --help                help for intercept
-      --nolog               Disables all loggging
-  -o, --output-dir string   directory to write output files
-      --silent              Enables log to file intercept.log
-  -v, --verbose count       increase verbosity level
 
-Use "intercept [command] --help" for more information about a command.
 
-```
 
+<br><br><br>
 
+# 🔋 Batteries Included
 
 
-<br><br><br>
 
-# 🔋 Batteries Included
+## Policy Types
 
-## SCAN Policies
+### SCAN Policies
 Scan policies enable thorough examination of non-binary files for regex patterns. These policies are crucial for identifying potential security risks such as leaked or hardcoded API keys, SSL certificates, passwords, and authentication tokens. A compliant state for a scan policy is achieved when the defined patterns are not found within the specified target path.
-## ASSURE Policies
+### ASSURE Policies
 Functioning inversely to scan policies, assurance policies enforce the presence of defined patterns. They utilize regex, CUE Lang schemas, or a combination of both. These policies are ideal for validating configuration files, log streams, and audit logs against expected patterns or structures. Compliance is achieved when the target matches the specified patterns, schemas, or values.
-### Configuration File Type Policies (JSON, YAML, TOML, INI)
+#### Configuration File Type Policies (JSON, YAML, TOML, INI)
 For monitored files with specific target types, Intercept can generate patches to bring non-compliant files back into compliance.
-### Endpoint API Policies
+#### Endpoint API Policies
 API policies apply assurance policy principles to API endpoints, ensuring they meet defined standards and expectations.
-## RUNTIME Policies
+### RUNTIME Policies
 Utilizing a YAML-based serverspec toolkit, runtime policies validate server configurations and real-time system states. They are essential for monitoring services and configuration states, enabling immediate response to changes and drifts in compliance.
-## REGO Policies
+### REGO Policies
 Leveraging the Open Policy Agent (OPA) engine, Rego policies assess compliance in complex scenarios. They excel in contextualized compliance checks where dynamic input data is necessary for accurate compliance status calculation.
 
+## Multiplatform Single Binary
 
+Low footprint, works anywhere.
 
-<br><br><br>
+## Integration Webhooks
+
+Send your Compliance Reports immediatly to the right recipient