docs: Update docs (#24)

* chore: Remove outdated content

Signed-off-by: Anurag Rajawat <[email protected]>

* docs: Update docs

Signed-off-by: Anurag Rajawat <[email protected]>

* chore: Add Pull Request template

Signed-off-by: Anurag Rajawat <[email protected]>

---------

Signed-off-by: Anurag Rajawat <[email protected]>

.github/pull_request_template.md

@@ -0,0 +1,43 @@
+## Description
+
+<!--
+Thank you for your pull request (PR)!
+Please provide a description of what your PR does providing a link (if applicable) to the issue it fixes.
+-->
+
+Fixes # (issue)
+
+**Does this PR introduce a breaking change?**
+
+## Checklist
+
+- [ ] PR title follows the `<type>: <description>` convention.
+- [ ] I use [conventional commits](https://www.conventionalcommits.org/) in my commit messages.
+- [ ] I have updated the [documentation](../docs) accordingly.
+- [ ] I Keep It Small and Simple: The smaller the PR is, the easier it is to review and have it merged.
+- [ ] I have performed a self-review of my code.
+- [ ] I have added tests that prove my fix is effective or that my feature works.
+- [ ] New and existing unit tests pass locally with my changes.
+
+## Additional information for reviewer
+
+#### Mention if this PR is part of any design or a continuation of previous PRs
+
+<!--
+The PR title must follow `<type>: <description>` convention:
+
+where: <br/>
+
+- `type` is to define what type of PR is this, most common types are as follows:
+    - `fix`   - for bug fixes or improvements.
+    - `feat`  - for new features which adds functionality.
+    - `chore` - for changes that do not relate to a fix or feature and don't modify src or test files.
+    - `docs`  - for changes related to documentation.
+    - `test`  - for changes related to tests.
+
+- `description` is a single line brief description of the changes made in the pull request.
+-->
+
+<!--
+Open your PR in Draft mode and verify all the applicable Checklist items before marking your issue as ready
+-->

README.md

@@ -1,26 +1,21 @@
 # SentryFlow
 
-[![SentryFlow Docker Build](https://github.com/5gsec/sentryflow/actions/workflows/release.yml/badge.svg)](https://github.com/5gsec/sentryflow/actions/workflows/release.yml) [![CI for SentryFlow](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-go.yml/badge.svg)](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-go.yml) [![CI for AI Engine](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-py.yml/badge.svg)](https://github.com/5gsec/sentryflow/actions/workflows/ci-test-py.yml)
-
-SentryFlow is a cloud-native system for API observability and security, specializing in log collection, metric production, and data exportation.
+SentryFlow is a cloud-native system for API observability, specializing in log collection, and data
+exportation.
 
 ## Architecture Overview
 
 ![SentryFlow_Overview](docs/sentryflow_overview.png)
 
 ### Features
 
-- Generation of API Access Logs
-- Production of API Metrics
-- AI-driven API Classification (Inference)
-
-## Documentation
+- API access observability
 
-### Basic Information
+[//]: # (- Production of API Metrics)
 
-- [Getting Started](docs/getting_started.md)
-- [Use Cases](examples/README.md)
+[//]: # (- AI-driven API Classification (Inference))
 
-### Contribution
+## Documentation
 
-- [Contribution Guide](contribution/README.md)
+- [Getting Started](docs/getting_started.md)
+- [Contribution Guide](docs/CONTRIBUTING.md)