**feat(core, docs): consolidate redundant files and improve documentation structure**

- **Storage**: Removed redundant storage implementation files from `/storage` directory while retaining necessary `baseStorage.ts`. Verified no impact on functionality with passing tests.
- **Documentation**: Consolidated multiple overlapping `.md` files into a single `statistics.md` file. Added structured sections for easier reference. Applied markdown naming conventions for clarity.
- **Project**: Introduced `CHANGES_SUMMARY.md` and `MARKDOWN_CONVENTIONS.md` to document changes and naming guidelines, improving project organization. Updated `demo.md` file naming for consistency.

**Purpose**: Simplify the codebase by removing duplicates, enhance maintainability through consolidated and structured documentation, and improve developer experience with clear guidelines and better organization.
This commit is contained in:
David Snelling 2025-07-24 11:13:03 -07:00
parent 0bbe30eea8
commit c7ed98e159
5 changed files with 375 additions and 2 deletions

View file

@ -69,15 +69,19 @@ configuration.
Brainy offers specialized packages for different use cases:
#### CLI Package
```bash
npm install -g @soulcraft/brainy-cli
```
Command-line interface for data management, bulk operations, and database administration.
#### Web Service Package
```bash
npm install @soulcraft/brainy-web-service
```
REST API web service wrapper that provides HTTP endpoints for search operations and database queries.
## 🏁 Quick Start
@ -493,7 +497,7 @@ const restoreResult = await db.restore(backupData, {clearExisting: true})
Brainy provides a way to get statistics about the current state of the database:
```typescript
import { BrainyData, getStatistics } from '@soulcraft/brainy'
import {BrainyData, getStatistics} from '@soulcraft/brainy'
// Create and initialize the database
const db = new BrainyData()
@ -509,6 +513,7 @@ const instanceStats = await db.getStatistics()
```
The statistics include:
- `nounCount`: Number of nouns (entities) in the database
- `verbCount`: Number of verbs (relationships) in the database
- `metadataCount`: Number of metadata entries
@ -1107,7 +1112,7 @@ The repository includes a comprehensive demo that showcases Brainy's main featur
- **[Try the live demo](https://soulcraft-research.github.io/brainy/demo/index.html)** - Check out the
interactive demo on
GitHub Pages
- Or run it locally with `npm run demo` (see [demo instructions](README.demo.md) for details)
- Or run it locally with `npm run demo` (see [demo instructions](demo.md) for details)
- To deploy your own version to GitHub Pages, use the GitHub Actions workflow in
`.github/workflows/deploy-demo.yml`,
which automatically deploys when pushing to the main branch or can be manually triggered