feat: add Quick Start, Task Management and PRs pages

.vitepress/config.mts

@@ -9,15 +9,19 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: "Home", link: "/" },
-      { text: "Examples", link: "/markdown-examples" },
+      { text: "Quick Start", link: "/quick-start" },
     ],
 
     sidebar: [
       {
-        text: "Examples",
+        text: "Quick Start",
+        items: [{ text: "Installation", link: "/quick-start" }],
+      },
+      {
+        text: "Development Flow",
         items: [
-          { text: "Markdown Examples", link: "/markdown-examples" },
-          { text: "Runtime API Examples", link: "/api-examples" },
+          { text: "Task Management", link: "/task-management" },
+          { text: "Pull Requests", link: "/pull-requests" },
         ],
       },
     ],

index.md

@@ -7,17 +7,9 @@ hero:
   tagline: "Guide for setting up, contributing, and collaborating on the ADAMANT Messenger"
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: Quick Start
+      link: /quick-start
     - theme: alt
-      text: API Examples
-      link: /api-examples
-
-features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+      text: Development Flow
+      link: /task-management
 ---

pull-requests.md

@@ -0,0 +1,48 @@
+---
+title: Pull Requests
+---
+
+# Pull Requests
+
+This page outlines the guidelines for creating branches, pull requests (PRs), and commit messages formatting.
+
+## Branch Naming
+
+To maintain clarity and avoid conflicts across systems, adhere to these branch naming rules:
+
+- **Prefixes**:
+
+  - Use `fix/` for bug fixes.
+  - Use `feat/` for new features.
+
+- **Formatting**:
+
+  - Only use lowercase letters, numbers, and hyphens (`-`) as separators.
+  - Avoid spaces, uppercase letters, or special characters.
+
+- **Use descriptive name**:
+  - ❌ **Bad**: `fix/error`
+  - ✅ **Good**: `fix/runtime-error-when-filling-kly-amount`
+
+## Pull Requests (PRs)
+
+When creating a PR, follow these guidelines:
+
+- Use the same name as the related Trello task for consistency and easier tracking.
+- Always choose the `dev` branch as the target branch when opening a PR.
+- Link the PR to its corresponding Trello task in the PR description.
+
+## Commit Message Formatting
+
+We follow the **Conventional Commits** standard for commit messages. This ensures consistency and compatibility with tools that rely on structured commit messages.
+
+### Examples
+
+- `fix: resolve runtime error when filling KLY amount`
+- `feat: implement user profile page`
+
+For more information, see the [Conventional Commits Documentation](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).
+
+---
+
+By following these guidelines, we ensure a smooth and structured development process.

quick-start.md

@@ -0,0 +1,42 @@
+---
+title: Quick Start
+---
+
+# Project setup
+
+Before you begin, ensure you have the following requirements installed.
+
+## Requirements
+
+- **Node.js** (version `>= 20.x`)
+- **npm** (comes with Node.js)
+- **Git** (version `>= 2.x`)
+- **Java** (required to generate TS types from Swagger schema)
+
+## Installation
+
+Clone the repository:
+
+```bash
+git clone --recursive https://github.com/Adamant-im/adamant-im.git
+```
+
+Install the dependencies:
+
+```bash
+npm install
+```
+
+Setup Git hooks (recommended):
+
+```bash
+npx husky
+```
+
+## Development
+
+Now run the development server as:
+
+```bash
+npm run dev
+```

task-management.md

@@ -0,0 +1,68 @@
+---
+title: Task Management
+---
+
+# Task Management
+
+We use **Trello** to manage tasks and track progress for the ADAMANT Messenger project.
+
+- Trello Board: [PWA](https://trello.com/b/tbpQhTTM/pwa)
+- Slack Channel: [#private-dev-pwa](https://app.slack.com/client/T7YMKRUJW/C052503LDQT)
+
+## Trello Board Columns
+
+Below is a description of each column on our Trello board and its purpose:
+
+| **Column**     | **Description**                                                          |
+| -------------- | ------------------------------------------------------------------------ |
+| **Backlog**    | Ideas or tasks that are not yet prioritized.                             |
+| **To Do**      | Tasks that have been selected for the current cycle but are not started. |
+| **In Process** | Tasks that are actively being worked on by developers.                   |
+| **On Review**  | Completed tasks waiting for code review.                                 |
+| **Testing**    | Tasks undergoing quality assurance testing.                              |
+| **Tested**     | Successfully tested tasks, ready for release.                            |
+| **Released**   | Tasks that are deployed and live in production.                          |
+
+## Responsibility for Moving Tasks
+
+| **Column**     | **Who Moves the Task** | **When to Move the Task**                                           |
+| -------------- | ---------------------- | ------------------------------------------------------------------- |
+| **Backlog**    | Team Lead              | When a new task or idea is created.                                 |
+| **To Do**      | Team Lead              | When prioritizing tasks for the current cycle.                      |
+| **In Process** | Developer              | When starting work on a task.                                       |
+| **On Review**  | Developer              | When the task's code is complete and ready for review.              |
+| **Testing**    | Team Lead              | When the code review is approved and the task is ready for testing. |
+| **Tested**     | Tester                 | When the task has passed all testing criteria.                      |
+| **Released**   | Team Lead              | After deployment to production.                                     |
+
+## General Guidelines
+
+- **Developers**:
+  - Ensure the task description is clear and you have all the necessary information before moving the task to **In Process**.
+  - After completing the work:
+    - Open a PR and add `bludnic` as a reviewer.
+    - Link the Trello task to the PR on GitHub.
+    - Move the task to **On Review**.
+    - _(Optional)_ Post a message in the [#private-dev-pwa](https://app.slack.com/client/T7YMKRUJW/C052503LDQT) Slack channel to speed up the reviewing process.
+- **Team Lead**:
+  - Prioritizing tasks from **Backlog** to **To Do**.
+  - Regularly review tasks in **On Review** and move them to **Testing** after the PR is approved.
+  - If a PR requires changes, move the task back to **In Process** so the developer can fix the issues.
+  - After a PR is approved, merge it into `dev` and move the task to **Testing**.
+  - After releasing to production (`dev` → `master`), move all accumulated tasks from **Tested** to **Released**.
+- **Testers**:
+  - Update the task status with testing notes after testing.
+  - If testing fails, move the task back to **In Process**.
+  - Move the task to **Tested** when all tests passed.
+
+By following this workflow, we ensure clarity and accountability for every task on the Trello board.
+
+---
+
+## Communication Guidelines
+
+- **For Code Issues**: Use the comments within the PR.
+- **For Testing Issues**: Communicate directly in Trello.
+- **Other Discussions**: Use the [#private-dev-pwa](https://app.slack.com/client/T7YMKRUJW/C052503LDQT) Slack channel as needed.
+
+By adhering to these guidelines, we streamline the workflow and maintain efficient communication within the team.