From 7d755ca9d9731424f8a03602772ab92cc1e19876 Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Sun, 1 Mar 2026 00:03:06 +0000 Subject: [PATCH] docs: refresh README links and Node version Co-authored-by: Levy Tate --- README.md | 6 +++++- docs/README.md | 2 ++ test/e2e/README.md | 1 + 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cf20a9b9..132f1cc0 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@

Platform Electron - Node.js + Node.js PRs Welcome

@@ -159,9 +159,12 @@ for step-by-step instructions on both platforms and how to handle unsigned-app p ### Developers — Build from Source +Recommended Node version is `20.11.0` (see `.nvmrc`). + ```bash git clone https://github.com/iLevyTate/StratoSortCore.git cd StratoSortCore +nvm use npm ci npm run dev ``` @@ -210,6 +213,7 @@ See **[SECURITY.md](SECURITY.md)** for the complete security policy. | **[Install Guide](docs/INSTALL_GUIDE.md)** | End-user install (Windows & Mac, no CLI) | | **[User Guide](docs/USER_GUIDE.md)** | Feature walkthrough for everyday use | | **[Beta Tester Guide](docs/BETA_TESTER_GUIDE.md)** | Testing + bug reporting for contributors | +| **[E2E Walkthrough](docs/E2E_WALKTHROUGH.md)** | Visual end-to-end walkthrough (UI/media) | | **[Getting Started](docs/GETTING_STARTED.md)** | Developer setup and build guide | | **[Architecture](docs/ARCHITECTURE.md)** | System design and data flow | | **[Graph Features](docs/FEATURES_GRAPH.md)** | Knowledge Graph capabilities | diff --git a/docs/README.md b/docs/README.md index 4b50b121..171f85f8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,6 +8,7 @@ find the right documentation for your needs. | Document | Description | Audience | | -------------------------------------------------------- | ----------------------------------------------------- | -------------- | | [CONFIG.md](./CONFIG.md) | Installation, dependencies & configuration | All users | +| [E2E_WALKTHROUGH.md](./E2E_WALKTHROUGH.md) | End-to-end app walkthrough (screenshots + videos) | All users | | [ARCHITECTURE.md](./ARCHITECTURE.md) | High-level system design and data flow | All developers | | [LEARNING_GUIDE.md](./LEARNING_GUIDE.md) | Codebase learning guide with glossary & code examples | New developers | | [CODE_QUALITY_STANDARDS.md](./CODE_QUALITY_STANDARDS.md) | Coding standards and style guide | All developers | @@ -73,6 +74,7 @@ docs/ ├── CODE_QUALITY_STANDARDS.md # Style guide ├── CONFIG.md # Environment variables ├── DI_PATTERNS.md # Dependency injection +├── E2E_WALKTHROUGH.md # End-to-end UI walkthrough (screenshots + videos) ├── ERROR_HANDLING_GUIDE.md # Error patterns ├── FEATURES_GRAPH.md # Knowledge Graph features ├── LEARNING_GUIDE.md # Developer onboarding (glossary + examples) diff --git a/test/e2e/README.md b/test/e2e/README.md index 3b5a22ae..376033eb 100644 --- a/test/e2e/README.md +++ b/test/e2e/README.md @@ -15,6 +15,7 @@ This test suite covers full user flows through the application UI, including: ## Prerequisites 1. **Node.js 18+** - Required for Playwright and Electron + - Recommended: `20.11.0` (see `.nvmrc`) 2. **Build the renderer** - Run `npm run build:dev` before testing 3. **Models downloaded (optional)** - Required for AI analysis tests, but tests handle missing models gracefully