soulcraft/brainy
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases 335 Packages Wiki Activity Actions

**docs: restructure CLI usage details and update scripts for clarity**

Browse source 
- **CLI Documentation Updates**:
  - Updated `README.md` to reflect the separation of CLI functionality into a new package: `@soulcraft/brainy-cli`.
  - Replaced inline CLI imports with instructions for installing and using `@soulcraft/brainy-cli`.
  - Clarified notes on keeping the main package lightweight by decoupling CLI functionality.

- **Script and Command Adjustments**:
  - Modified build instructions in `README.demo.md` to use `npm run build && npm run build:browser`.
  - Updated demo scripts in `package.json` to point to `/demo/index.html` instead of `/index.html`.
  - Revised style-check script in `CONTRIBUTING.md` to use `npm run check:style`.

- **Issues and Contribution Guidelines**:
  - Improved issue reporting section in `DEVELOPERS.md` with clearer guidelines and examples for bug and feature requests.

**Purpose**: These changes enhance documentation accuracy, streamline developer guidance, and ensure commands/scripts are up-to-date with current usage patterns.
This commit is contained in:
David Snelling 2025-07-17 07:53:41 -07:00
parent a1d564ed64
commit 7878f200fc
5 changed files with 9 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

2
README.demo.md
View file

@ -35,7 +35,7 @@ npx http-server
If you see the error "Could not load Brainy library. Please ensure the project is built and served over HTTP", check the
following:
1. Make sure you've built the project with `npm run build:all`
1. Make sure you've built the project with `npm run build && npm run build:browser`
2. Ensure you're accessing the demo through HTTP (not by opening the file directly)
3. Check your browser's console for additional error messages