docs: refresh product and platform messaging (#103)

Reframes the README and docs around TeslaSync’s self-hosted operations platform, adds Why TeslaSync and platform catalog pages, and updates Helix, deployment profiles, architecture, and product metrics.

Author: atulmgupta

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TeslaSync Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -3,7 +3,7 @@ import { withMermaid } from 'vitepress-plugin-mermaid'
 
 export default withMermaid(defineConfig({
   title: 'TeslaSync Docs',
-  description: 'Documentation for TeslaSync - Tesla Fleet Intelligence Platform',
+  description: 'Open-source Tesla intelligence on your infrastructure. Installation, Tesla connectivity, operations, and contributing.',
   base: '/teslasync/',
 
   ignoreDeadLinks: true,
@@ -42,7 +42,7 @@ export default withMermaid(defineConfig({
       { text: 'Guide', link: '/guide/getting-started', activeMatch: '/guide/' },
       { text: 'Deployment', link: '/deployment/docker', activeMatch: '/deployment/' },
       { text: 'Features', link: '/features/dashboard', activeMatch: '/features/' },
-      { text: 'Contributing', link: '/contributing/code-structure', activeMatch: '/contributing/' },
+      { text: 'Contributing', link: '/CONTRIBUTING', activeMatch: '/(CONTRIBUTING|contributing/)' },
     ],
 
     sidebar: {
@@ -52,6 +52,7 @@ export default withMermaid(defineConfig({
           items: [
             { text: 'Getting Started', link: '/guide/getting-started' },
             { text: 'Tesla Fleet API Setup', link: '/guide/tesla-fleet-api' },
+            { text: 'Enable Fleet Telemetry', link: '/guide/fleet-telemetry' },
             { text: 'Configuration', link: '/guide/configuration' },
             { text: 'Local Development', link: '/guide/local-development' },
             { text: 'Architecture', link: '/guide/architecture' },
@@ -60,7 +61,6 @@ export default withMermaid(defineConfig({
             { text: 'Diagrams', link: '/guide/diagrams' },
             { text: 'Database Schema', link: '/guide/database' },
             { text: 'Technology Stack', link: '/guide/technology' },
-            { text: 'Fleet Telemetry', link: '/guide/fleet-telemetry' },
             { text: 'Helix AI', link: '/guide/helix-ai' },
             { text: 'Remote Commands', link: '/guide/remote-commands' },
             { text: 'Troubleshooting', link: '/guide/troubleshooting' },
@@ -99,6 +99,7 @@ export default withMermaid(defineConfig({
         {
           text: 'Contributing',
           items: [
+            { text: 'Start Contributing', link: '/CONTRIBUTING' },
             { text: 'Code Structure', link: '/contributing/code-structure' },
             { text: 'Adding Features', link: '/contributing/adding-features' },
             { text: 'API Reference', link: '/contributing/api-reference' },

docs/.vitepress/config.ts

@@ -1,5 +1,37 @@
 # Contributing to TeslaSync
 
+Documentation fixes, reproducible bug reports, tests, and focused code changes
+are welcome. For installation rather than development, use
+[Getting Started](/guide/getting-started).
+
+## Choose your first contribution
+
+1. Check [existing issues](https://github.com/ev-dev-labs/teslasync/issues) and discuss
+   substantial changes before investing in an implementation.
+2. Fork or branch, reproduce the problem, and keep the change focused.
+3. Read the repository's `.github/instructions/` rules for the files you touch.
+4. Run the relevant existing checks below; record actual results and limitations.
+5. Open a PR describing what changed, why, how to test it, and any migration impact.
+
+For documentation-only work:
+
+```bash
+cd docs
+npm ci
+npm run docs:dev
+# After editing, stop the preview and verify:
+npm run docs:build
+```
+
+Check links in the rendered site under `/teslasync/`, including screenshots,
+anchors, and sidebar entries. The site currently ignores dead links during
+build, so build success is not a link audit. No Go or frontend build is needed
+for prose-only changes.
+
+Never include credentials, private keys, VINs, or precise locations in reports.
+Follow the [security policy](https://github.com/ev-dev-labs/teslasync/blob/main/SECURITY.md)
+for vulnerabilities instead of opening a public issue.
+
 This is the **first PR runbook**: clone → run → ship your first change.
 For the deeper "how to add a vertical-slice feature" walkthrough, see
 [`contributing/adding-features.md`](contributing/adding-features.md).
@@ -22,8 +54,8 @@ material.
 | Docker Desktop / Engine | 24+ | TimescaleDB, Redis, Mosquitto, integration smoke |
 | `golangci-lint` | v1.64+ | Backend lint gate |
 | `pre-commit` | latest | Local hook runner (pip install) |
-| `make` | GNU Make 4+ | Verification chain. **Windows users**: not installed by default — use Git Bash's `make` (ships with Git for Windows), WSL, or the Docker one-liner shown below. The Makefile uses POSIX-only syntax that doesn't run under nmake. |
-| `gh` CLI | optional | PR management once we open PRs in phase D |
+| `make` | GNU Make 4+ | Verification chain. On Windows use WSL or a separately installed GNU Make with a POSIX shell. Git for Windows does not include Make by default; nmake is not compatible. |
+| `gh` CLI | optional | Issue and pull-request management |
 
 Verify after install:
 
@@ -36,18 +68,12 @@ pre-commit --version
 make --version          # GNU Make 4.x (or run via Docker — see below)
 ```
 
-### Windows-only: running `make` without installing it
-
-If `make` isn't on your `PATH` and you don't want to install it
-globally, you can run any target via Docker (uses the Alpine `make`
-package; no host install required):
-
-```powershell
-docker run --rm -v "${PWD}:/work" -w /work alpine:3.20 sh -c "apk add --no-cache make >/dev/null && make verify"
-```
+### Windows development
 
-Substitute `verify` for any target. This is the same approach the
-maintainer uses for ad-hoc validation on Windows during development.
+Use a WSL development environment with the listed toolchains for Make targets,
+or run the underlying commands directly. A container with only `make` installed
+cannot run Go, Node.js, and lint gates. Go race tests also require a supported
+C toolchain. See [Local Development](/guide/local-development) for service setup.
 
 ## First run — clone to green build
 
@@ -186,8 +212,7 @@ Types: `feat`, `fix`, `refactor`, `perf`, `docs`, `test`, `chore`,
 Scope: `web`, `api`, `db`, `mqtt`, `helm`, `ci`, or a specific feature
 name.
 
-All commits must include the agent attribution trailer (added
-automatically by the agent toolchain):
+For Copilot-assisted commits, retain the applicable attribution trailer:
 
 ```
 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>