brainy/docs/guides
David Snelling e838327a22 feat: add frozen flag for complete immutability and simplify README examples
- Add frozen flag to separate data immutability from performance optimizations
  - readOnly: prevents data mutations but allows index optimizations (default behavior)
  - frozen: prevents ALL changes including statistics and index updates
  - Smart default: frozen=false when readOnly=true for optimal performance

- Add comprehensive documentation for read-only and frozen modes
  - Created docs/guides/readonly-frozen-modes.md with detailed guide
  - Added examples for compliance, forensics, and testing use cases
  - Updated all documentation indexes with new guide links

- Simplify README.md to emphasize unified API
  - Clearer demonstration that same code works everywhere
  - Simplified framework examples showing consistent API
  - Better noun/verb examples for entities and relationships
  - Collapsible sections for cloud platform examples
  - Environment auto-detection table

- Add tests for frozen flag behavior
  - Test readOnly without frozen (allows optimizations)
  - Test frozen mode (complete immutability)
  - Test dynamic mode switching

BREAKING CHANGE: readOnly behavior changed - now allows optimizations by default.
To get old behavior (complete immutability), use readOnly: true with frozen: true.
2025-08-06 09:52:45 -07:00
..
cache-configuration.md **feat(docs): add comprehensive cache configuration guide and enhance adaptive tuning** 2025-08-01 11:47:34 -07:00
hnsw-field-search.md **feat(search): enhance JSON document search with field-level filtering and prioritization** 2025-08-01 08:27:39 -07:00
json-document-search.md **feat(search): enhance JSON document search with field-level filtering and prioritization** 2025-08-01 08:27:39 -07:00
model-management.md **feat(brainy-models): implement robust format field validation and update workflow scripts** 2025-08-01 18:00:36 -07:00
offline-model-reliability.md feat(reliability): implement automatic offline model detection for production 2025-08-05 09:32:15 -07:00
optional-model-bundling.md **feat(docs): add comprehensive documentation for model bundling and robust loading** 2025-08-01 15:35:29 -07:00
production-migration-guide.md **chore: remove outdated changelog and summary documents** 2025-07-30 11:51:39 -07:00
readonly-frozen-modes.md feat: add frozen flag for complete immutability and simplify README examples 2025-08-06 09:52:45 -07:00
service-identification.md **docs(guides): add service identification guide** 2025-08-01 10:16:18 -07:00