Moved main docs to root; Removed decision files (were added to decisi…

…on issues bodies - #186)
Monstarrrr · Jun 21, 2024 · d8d6f94 · d8d6f94
1 parent 076da71
commit d8d6f94
Show file tree

Hide file tree

Showing 12 changed files with 13 additions and 546 deletions.
diff --git a/.github/ISSUE_TEMPLATE/decision.md b/.github/ISSUE_TEMPLATE/decision.md
@@ -4,7 +4,6 @@ about: To open a discussion and documentation for a key decision about the proje
 title: Decide on <TOPIC>
 labels: decision
 assignees: ''
-
 ---
 
 - **Impact**:
@@ -17,8 +16,6 @@ assignees: ''
  - @seporterfield (? / 5️)
  - @Monstarrrr (? / 5️)
 
-- **Last updated**: [DD-MM-YYYY]
-
 ## Context <!--optional -->
 
 [Communicate what this decision is about exactly; the importance of it;]

diff --git a/.github/workflows/decision.yml b/.github/workflows/decision.yml
diff --git a/docs/governance/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md b/docs/governance/CODE_OF_CONDUCT.md → docs/CODE_OF_CONDUCT.md
diff --git a/docs/governance/CONTRIBUTING.md → docs/CONTRIBUTING.md b/docs/governance/CONTRIBUTING.md → docs/CONTRIBUTING.md
diff --git a/docs/README.md b/docs/README.md
@@ -8,8 +8,8 @@ Official repository of [rebutify.org](https://rebutify.org)
  - [1.1 Environment Variables](#11-environment-variables)
  - [1.2. Docker](#12-docker)
  - [1.3. Python](#13-python)
-  - [Unix OS](#unix-os)
-  - [Windows OS](#windows-os)
+ - [Unix OS](#unix-os)
+ - [Windows OS](#windows-os)
 - [2. Deployment](#2-deployment)
 - [3. Contributing](#3-contributing)
 
@@ -36,21 +36,28 @@ docker compose up
 
 ## 1.3. Python
 
-**Install** the dependencies in a new virtual environment from the root directory ``/rebutify``.
+**Install** the dependencies in a new virtual environment from the root directory `/rebutify`.
 
 ```bash
 python -m venv .venv
 ```
-----
+
+---
+
 #### Unix OS
+
 ```bash
 source .venv/bin/activate
 ```
+
 #### Windows OS
+
 ```bash
 source .venv/Scripts/activate
 ```
-----
+
+---
+
 ```bash
 pip install -r requirements.txt
 ```
@@ -65,4 +72,4 @@ gunicorn --bind 0.0.0.0:8000 -k uvicorn.workers.UvicornWorker rebutify.asgi:appl
 
 # 3. Contributing
 
-For instructions on contributing, read [CONTRIBUTING.md](governance/CONTRIBUTING.md).
+For instructions on contributing, read [CONTRIBUTING.md](./CONTRIBUTING.md).
diff --git a/docs/decisions/_template.md b/docs/decisions/_template.md
diff --git a/docs/decisions/architecture/api-paradigm.md b/docs/decisions/architecture/api-paradigm.md
diff --git a/docs/decisions/architecture/automating-api-docs_DECISION.md b/docs/decisions/architecture/automating-api-docs_DECISION.md