**docs: restructure CLI usage details and update scripts for clarity**
- **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:
parent
078ae4a879
commit
99ed56c1f1
5 changed files with 9 additions and 23 deletions
|
|
@ -168,11 +168,7 @@ These optimizations are particularly beneficial for:
|
|||
|
||||
## Reporting Issues
|
||||
|
||||
We use GitHub issues to track bugs and feature requests. Please use the provided issue templates when creating a new
|
||||
issue:
|
||||
|
||||
- [Bug Report Template](.github/ISSUE_TEMPLATE/bug_report.md)
|
||||
- [Feature Request Template](.github/ISSUE_TEMPLATE/feature_request.md)
|
||||
We use GitHub issues to track bugs and feature requests. When creating a new issue, please provide detailed information including steps to reproduce, expected behavior, and actual behavior for bugs, or clear use cases and benefits for feature requests.
|
||||
|
||||
## Code Style Guidelines
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue