From 2fea43acd6283061551f54cd92db0006ad0a5e4e Mon Sep 17 00:00:00 2001 From: David Snelling Date: Fri, 4 Jul 2025 10:27:07 -0700 Subject: [PATCH] docs: update Node.js version requirement to 23.0.0 in documentation --- README.demo.md | 2 +- README.md | 9 +++------ docs/publishing-cli.md | 13 ++++++++++--- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/README.demo.md b/README.demo.md index 9bdd2272..6183adbb 100644 --- a/README.demo.md +++ b/README.demo.md @@ -4,7 +4,7 @@ The Brainy interactive demo showcases the library's features in a web browser. F ## Prerequisites -- Make sure you have Node.js installed (version 24.0.0 or higher) +- Make sure you have Node.js installed (version 23.0.0 or higher) - Ensure the project is built (run both `npm run build` and `npm run build:browser`) ## Running the Demo diff --git a/README.md b/README.md index 241302ad..e5575fa1 100644 --- a/README.md +++ b/README.md @@ -280,7 +280,6 @@ Brainy's pipeline is designed to handle streaming data efficiently: - Automatic thread management based on environment capabilities - Example: `executeTypedPipeline(augmentations, method, args, { mode: ExecutionMode.THREADED })` - ### Running the Pipeline The pipeline runs automatically when you: @@ -416,7 +415,6 @@ brainy visualize brainy visualize --root --depth 3 ``` - ### Using the CLI in Your Code If you need to use the CLI functionality in your code, you can import it explicitly: @@ -432,7 +430,6 @@ import '@soulcraft/brainy/cli' This will only build and load the CLI when you explicitly import it, keeping your bundle size small when you don't need the CLI. - ### Available Commands #### Basic Database Operations: @@ -1251,14 +1248,14 @@ comprehensive [Scaling Strategy](scalingStrategy.md) document. ## Requirements -- Node.js >= 24.0.0 - +- Node.js >= 23.0.0 ## Contributing For detailed contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md). -For developer documentation, including building, testing, and publishing instructions, please see [DEVELOPERS.md](DEVELOPERS.md). +For developer documentation, including building, testing, and publishing instructions, please +see [DEVELOPERS.md](DEVELOPERS.md). We have a [Code of Conduct](CODE_OF_CONDUCT.md) that all contributors are expected to follow. diff --git a/docs/publishing-cli.md b/docs/publishing-cli.md index 5cc6e3d1..47a92613 100644 --- a/docs/publishing-cli.md +++ b/docs/publishing-cli.md @@ -6,13 +6,14 @@ This document explains how to publish both the @soulcraft/brainy and @soulcraft/ Before publishing, ensure you have: -1. Node.js >= 24.0.0 installed +1. Node.js >= 23.0.0 installed 2. An npm account with access to the @soulcraft organization 3. Logged in to npm using `npm login` ## Publishing Process -The repository is set up to publish both packages together with synchronized versions. To publish the packages, follow these steps: +The repository is set up to publish both packages together with synchronized versions. To publish the packages, follow +these steps: ### 1. Ensure you're in the root directory of the project @@ -37,6 +38,7 @@ npm run publish:both ``` This command will: + - Ensure versions are in sync between both packages - Build the main package - Build the CLI @@ -51,6 +53,7 @@ npm run publish ``` This command will: + - Build the main package - Publish the main package to npm @@ -61,6 +64,7 @@ npm run publish:cli ``` This command will: + - Ensure versions are in sync - Build the CLI package - Publish the CLI package to npm @@ -104,11 +108,13 @@ The `publish:cli` command: 4. Publishes the CLI package with `npm publish` The version synchronization ensures that: + - Both packages always have the same version number - The CLI package's dependency on the main package is exact (not using the ^ prefix) - The README.md file is updated with the current version The CLI package is configured in `cli-package/package.json` with: + - The correct package name: `@soulcraft/brainy-cli` - `"private": false` to allow publishing - `"publishConfig": { "access": "public" }` to ensure the scoped package is public @@ -121,7 +127,8 @@ If you encounter any issues during the publishing process: 1. Make sure you're logged in to npm with an account that has access to the @soulcraft organization 2. Ensure that the `dist/cli.js` file exists and has been built correctly -3. If you get an error about the package already existing, you may need to update the version in both package.json files: +3. If you get an error about the package already existing, you may need to update the version in both package.json + files: ```bash npm version patch # This will update both package.json files via the version script ```