docs(readme): polish README + add ROADMAP, SUPPORT, 8 screenshots

[parth0025]

Summary

The front-door upgrade for AlianHub's public-facing docs. Step 6 of the open-source repo maintenance baseline initiative (#207 license, #208 branching, #209 lint, #212 releases, #213 docker).

Turns the README from a functional document into a product page — with hero screenshot, badges, architecture diagram, 8 product screenshots, expanded features, and routing for contributors / users / customers.

Files changed (12)

File	Status	Detail
README.md	Modified	213 → 429 lines (+216). Heavy structural changes — see below
CONTRIBUTING.md	Modified	+21 lines — new Commit Message Format section
ROADMAP.md	New (75 lines)	Public roadmap template — categories with placeholder bullets you fill in
SUPPORT.md	New (86 lines)	Where-to-go routing matrix + bug-report content guide
.gitbook/assets/screenshots/dashboard.png	New (95 KB)	Customizable dashboard with widgets
.gitbook/assets/screenshots/board-view.png	New (124 KB)	Kanban with status columns
.gitbook/assets/screenshots/list-view.png	New (199 KB)	Dense list with bulk-action toolbar
.gitbook/assets/screenshots/calendar-view.png	New (118 KB)	Monthly calendar with color-coded bars
.gitbook/assets/screenshots/task-detail.png	New (125 KB)	Task detail with custom fields
.gitbook/assets/screenshots/workload-report.png	New (128 KB)	Workload timesheet — capacity planning
.gitbook/assets/screenshots/settings.png	New (171 KB)	Deep customization page
.gitbook/assets/screenshots/ai-assist.png	New (226 KB)	AI prompt-template library

Total binary additions: 1.2 MB across 8 screenshots (avg 155 KB each, no compression needed).

New README structure

Hero (logo + tagline + nav + Demo button)
└─ Badges row (5: License, CoC, Release, Discussions, Stars)
└─ Hero screenshot                  ← NEW
└─ Quick Start
   ├─ 🐳 Option 1 — Docker (recommended)
   └─ 🛠 Option 2 — From source
└─ What is AlianHub?
└─ Architecture (Mermaid)           ← NEW — Vue/Electron → Express+Socket.io → MongoDB
└─ Tech Stack
└─ Key Features                      ← EXPANDED (9 descriptive paragraphs)
└─ 📸 Screenshots                    ← NEW (8 subsections)
   ├─ Dashboard
   ├─ Board View (Kanban)
   ├─ List View
   ├─ Calendar View
   ├─ Task Detail
   ├─ Workload Report               ← differentiator vs other OSS PMS
   ├─ Settings & Customization
   └─ AI Assist
└─ Documentation                     ← renamed from "Getting Started"
└─ Demo
└─ Roadmap                           ← NEW (links to ROADMAP.md)
└─ Contributing                      ← REWRITTEN (links BRANCHING.md, good-first-issue, help-wanted)
└─ Support & Community               ← NEW (where-to-go matrix → SUPPORT.md)
└─ Governance
└─ Security
└─ Contributors ♥️ Thanks
└─ Repo Activity                     ← NEW (commit-activity, last-commit, PRs merged, open issues)
└─ License                           ← UNCHANGED (#207's territory)

Intentional non-conflicts with other open PRs

File / region	Owned by	Why we didn't touch it
README License badge (line 35)	PR #207	Would conflict on merge
README "License" section (bottom)	PR #207	Would conflict on merge
CONTRIBUTING.md § Submitting Pull Requests + Branch Naming	PR #208	Would conflict on merge
.github/pull_request_template.md	PR #209	Would conflict on merge
CHANGELOG.md	PR #212	Already created there

All edits live in non-overlapping regions. PRs can land in any order.

Forward references (resolve as other PRs land)

Reference	Resolves when
BRANCHING.md link in README	#208 lands
commitlint.config.js link in CONTRIBUTING.md	#209 lands
CHANGELOG.md link	#212 lands
docker-compose.yml Quick Start example	#213 lands

Screenshots — important rendering note

The 8 screenshots use absolute URLs pointing to raw.githubusercontent.com/.../main/.... Behavior:

Where	Renders?
In this PR's preview (against staging)	❌ Broken — files don't exist on main yet
After staging → main promotion	✅ Renders immediately (GitHub CDN serves within ~5 min)
On GitHub main branch page	✅ Permanently
On external markdown viewers (npm, Docker Hub, blogs)	✅ Permanently

This is the same URL pattern the existing hero image already uses — proven working on this repo.

Decisions documented

Decision	Choice	Why
Screenshots URL strategy	/main/... absolute raw URLs	Works on all viewers (not just github.com); same pattern as existing hero
Screenshots section placement	After Key Features, before Documentation	Reader reads features → sees proof → reads docs
Mermaid for architecture	Native GitHub rendering	No image upload, editable in PRs
ROADMAP placeholder bullets	Don't pretend to know the actual roadmap	You fill in real items after merge
Skip FUNDING.yml	No GitHub Sponsors enrollment confirmed	Easy 3-line add later
Repobeats vs Star History	Use GitHub-native shields, comment shows Repobeats upgrade path	No external signup required

Test plan

• On GitHub, view the PR diff — README renders without syntax issues
• After PR merges to staging: visit the staging branch README on github.com → all sections render
• After staging → main: visit https://raw.githubusercontent.com/aliansoftwareteam/AlianHub-Project-Management-System/main/.gitbook/assets/screenshots/dashboard.png → returns the dashboard PNG (HTTP 200)
• After staging → main: re-check the README on github.com main → all 8 screenshots render inline
• Mermaid diagram renders (GitHub renders Mermaid natively)
• ROADMAP.md and SUPPORT.md are reachable via links from README

What's NOT in this PR (intentionally out of scope)

• ❌ Star History chart — removed per your request, will plan separately later
• ❌ FUNDING.yml — needs GitHub Sponsors enrollment first
• ❌ README_DOC.md changes — separate detailed install doc; out of scope
• ❌ TEST-REPORT.md cleanup — stale May 2025 file; out of scope
• ❌ Removing installation/ from .dockerignore — Docker PR (ci(docker): publish multi-arch images to GHCR + complete compose stack #213) concern

🤖 Generated with Claude Code

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 7a933f76-bb69-49ea-b7ff-e62ead3b9f2f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-polish

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}