updated docs

Signed-off-by: RAWx18 <rawx18.dev@gmail.com>

Author: RAWx18

CONTRIBUTING.md

@@ -1,83 +1,149 @@
-# Contributing to GitMesh
+# Contributing to GitMesh (Community Edition)
 
-Thank you for your interest in contributing to GitMesh! This document provides guidelines for contributing to the project.
+This document describes the minimal rules and workflow for contributing to GitMesh Community Edition.
 
-## Developer Certificate of Origin (DCO)
+---
 
-All commits must include a "Signed-off-by" line to certify that you have the right to submit the code under the project's license. This is done using the Developer Certificate of Origin (DCO).
+## Commit sign-off (DCO)
 
-To sign your commits, use the `-s` flag with git commit:
+All commits **must** be signed off using the Developer Certificate of Origin (DCO).
 
-```shell
-git commit -s -m "Your commit message"
-```
+Create a signed commit:
+```bash
+git commit -s -m "your commit message"
+````
 
-This will add a line like:
-```
-Signed-off-by: Your Name <your.email@example.com>
-```
+Fix a missing sign-off on the last commit:
 
-**Important:** All commits in your PR must have DCO sign-off. PRs without proper sign-off will not pass the required DCO check.
-
-If you forget to sign your commits, you can amend your last commit with:
-```shell
+```bash
 git commit --amend -s
 ```
 
-To sign multiple commits in your branch, you have two common options:
+Sign multiple commits:
 
-- Rebase onto your base branch (replace `main` with your actual base branch, e.g., `main`, `master`, `develop`):
-  ```shell
-  git rebase --signoff main
-  ```
-- Or rebase only the last N commits (replace `N` with the number of commits you want to sign):
-  ```shell
-  git rebase --signoff HEAD~N
-  ```
+```bash
+git rebase --signoff main
+# or
+git rebase --signoff HEAD~N
+```
 
-**Note:** Rebasing can cause conflicts. Resolve any conflicts as they appear and continue the rebase with `git rebase --continue`.
+Pull requests without valid sign-off will be rejected.
 
-## Getting Started
+---
 
-1. Get the mono repo from GitHub
+## Local development
 
-```shell
-git clone [YOUR_REPOSITORY_URL]
-```
+### Prerequisites
 
-2. Run the start script:
+* Node.js (LTS)
+* Docker + Docker Compose
+* Git
 
-```shell
-cd scripts
-./cli prod
-```
+### Setup
 
-For hot reloading, you can run:
-```shell
+```bash
+git clone <your-fork-url>
+cd gitmesh
 cd scripts
 ./cli clean-dev
 ```
 
-The app will be available at http://localhost:8081
+### Environment files
 
-### Running services individually
+Both frontend and backend require the following environment configuration files:
 
-To optimize resource usage during development, we would suggest starting only the necessary services and leveraging hot reloading where applicable. 
+**Backend & Frontend `.env` files:**
+* `.env.dist.local` - Distribution template for local development
+* `.env.dist.composed` - Distribution template for Docker Compose
+* `.env.override.local` - Local overrides (for local development)
+* `.env.override.composed` - Overrides for Docker Compose
 
-1. Start the scaffold service, including the necessary components like the database, etc:
+The application runs at:
 
-```shell
-./cli scaffold up 
+```
+http://localhost:8081
 ```
 
-This will set up the foundational services required for the project.
-
-2. If you are primarily working on the frontend but also need the API without hot reloading:
+### Running fewer services
 
+To reduce resource usage:
 
-```shell
+```bash
+./cli scaffold up
 DEV=1 ./cli service frontend up
 ./cli service api up
 ```
 
-By selectively starting the frontend and API services without enabling hot reloading, helps reduce resource usage. 
+---
+
+## Vibe coding (optional)
+
+If you use agent-based or IDE-assisted “vibe coding”, GitMesh provides helper scripts that create local symlinks.
+
+Enable:
+
+```bash
+./gitmesh/setup-vibe.sh
+```
+
+Disable / clean up:
+
+```bash
+./gitmesh/remove-vibe.sh
+```
+
+These scripts modify your local workspace only.
+Do **not** commit generated symlinks or agent artifacts.
+Always review generated code carefully before committing.
+
+---
+
+## Contributing workflow
+
+1. Fork the repository
+2. Create a branch:
+
+   ```bash
+   git checkout -b type/short-description
+   ```
+3. Make changes and commit with sign-off:
+
+   ```bash
+   git commit -s -m "clear commit message"
+   ```
+4. Push to your fork:
+
+   ```bash
+   git push origin type/short-description
+   ```
+5. Open a pull request to the upstream repository
+
+---
+
+## Pull request expectations
+
+* Keep PRs small and focused
+* Explain what changed and why
+* Include testing or reproduction steps when relevant
+* Avoid committing local configs, symlinks, or temp files
+
+---
+
+## Staying up to date
+
+```bash
+git stash
+git pull origin main
+git stash pop
+```
+
+---
+
+## Getting help
+
+* GitHub Issues: bugs, features, technical discussion
+* Discord: real-time help and coordination
+
+---
+
+By contributing, you agree that your work is licensed under the project’s Apache 2.0 license and complies with the DCO.

README.md

@@ -22,11 +22,21 @@
 
 ---
 
-## The Hunt Begins
+## What is GitMesh?
+
+**GitMesh Community Edition** aggregates external product signals from GitHub, Reddit, X, Discord, and Stack Overflow, deduplicates and classifies them, and surfaces them alongside existing issues and sprints through two-way sync with Jira, GitHub, and Linear. Engineering and product teams get shared visibility into customer feedback and delivery progress in one place, reducing manual triage and context switching.
+
+<details>
+<summary><strong>Enterprise Edition</strong></summary>
+
+``` GitMesh Enterprise Edition adds a capacity-aware intelligence layer that correlates those signals with your product surface, roadmap constraints, and team capacity to produce capacity-constrained, ranked backlogs and executable GitHub issues with persistent decision rationale, approval workflows, and audit logs. Leaders interact through an agentic interface with role-based controls to propose, evaluate, and approve prioritization and sprint changes—turning visibility into velocity. ```
+
+Website: ``` www.alveoli.app ``` (Offered by Alveoli)
+
+</details>
+
 
-**GitMesh** watches thousands of signals across GitHub, Reddit, X, Discord, Stack Overflow, and beyond, then correlates them with your team's actual capacity and sprint progress. Instead of manually triaging feedback or guessing priorities, you get auto-generated GitHub issues ranked by impact, ICP fit, and competitive gaps. It maps work to the right engineers, syncs milestones across your stack, and even guides implementation so your team ships what users need, not just what they asked for.
 
-**Meet Meshy, our pack leader**, a wolf whose instincts mirror GitMesh's core philosophy: agile, resilient, and unstoppable together. Like wolves in a pack, we thrive on coordination, moving as one efficient and powerful force.
 
 ---
 

SECURITY.md

@@ -47,9 +47,9 @@ If you discover or suspect a security vulnerability in **GitMesh EE**, do **not*
 
 Instead, report EE issues directly and only to:
 
-* **CTO of Alveoli – Security Contact for EE**
-  **Name:** Ronit Raj
-  **Email:** `ronitk964@gmail.com`
+* **CEO of Alveoli – Security Contact for EE**
+  **Name:** Ryan Madhuwala
+  **Email:** `rawx18.dev@gmail.com`
 
 EE issues are handled solely through Alveoli’s internal security and engineering processes.
 
@@ -180,16 +180,16 @@ GitMesh EE is:
 * Not open source and not licensed under Apache License 2.0
 * Governed by terms defined by Alveoli for the use of EE
 
-All EE security issues must be reported **only** to the **CTO of Alveoli**:
+All EE security issues must be reported **only** to the **CEO of Alveoli**:
 
-* **EE Security Contact – CTO of Alveoli**: `ronitk964@gmail.com`
+* **EE Security Contact – CEO of Alveoli**: `rawx18.dev@gmail.com`
 
 No rights to inspect, modify, or redistribute GitMesh EE are granted beyond those explicitly permitted by Alveoli. All rights, title, and interest in GitMesh EE, including all intellectual property rights, remain solely with Alveoli.
 
 If any GitMesh EE code is ever inadvertently included in or distributed with GitMesh CE, that code remains the exclusive proprietary property of Alveoli. It must not be used, executed, copied, modified, incorporated, or redistributed for any reason. Any such discovery should be reported immediately:
 
 * For CE repositories or artifacts: to the **Lab Leader** (`rawx18.dev@gmail.com`)
-* For EE code concerns: to the **CTO of Alveoli** (`ronitk964@gmail.com`)
+* For EE code concerns: to the **CEO of Alveoli** (`rawx18.dev@gmail.com`)
 
 All recipients must remove the affected material from all systems, repositories, forks, mirrors, backups, and distributions upon discovery. The accidental presence of Enterprise Edition code in any CE repository or distribution does not grant any license or permission to use it in any way.
 
@@ -214,8 +214,8 @@ Users should keep GitMesh, underlying operating systems, and related infrastruct
 * **GitMesh CE Security – Lab Leader (Ryan Madhuwala)**
   `rawx18.dev@gmail.com`
 
-* **GitMesh EE Security – CTO of Alveoli (Ronit Raj)**
-  `ronitk964@gmail.com`
+* **GitMesh EE Security – CTO of Alveoli (Ryan Madhuwala)**
+  `rawx18.dev@gmail.com`
 
 * **LFDT (Escalation for CE only)**
   `support@lfdecentralizedtrust.org`