77
88## Core Vision
99
10- HeraldStack is an ambient intelligence system that integrates memory, emotion,
11- and modular execution across a trusted cohort of AI entities to restore
12- momentum, anchor decisions, and evolve alongside Bryan's ongoing personal and
13- professional journey.
10+ HeraldStack is an am## Directory Structure Overview
11+
12+ For a detailed, canonical description of the project's directory structure, see:
13+
14+ - [ docs/DETAILED.md] ( docs/DETAILED.md ) – ** Directory Structure and Naming Best
15+ Practices** (includes a ` tree ` overview and rationale)
16+ - [ docs/naming-conventions.md] ( docs/naming-conventions.md ) – ** Directory and
17+ file naming conventions**
18+ - [ docs/DEVELOPMENT-PRINCIPLES.md] ( docs/DEVELOPMENT-PRINCIPLES.md ) –
19+ ** Development principles and migration history**
20+
21+ Historical migration documents have been moved to
22+ [ docs/migration/archive/] ( docs/migration/archive/ ) for reference.gence system
23+ that integrates memory, emotion, and modular execution across a trusted cohort
24+ of AI entities to restore momentum, anchor decisions, and evolve alongside
25+ Bryan's ongoing personal and professional journey.
1426
1527## 🚨 Critical Development Principles
1628
@@ -36,9 +48,17 @@ The following should remain as shell scripts:
3648Before manually fixing linting/formatting issues, run our automated tools:
3749
3850``` bash
39- ./scripts/validation/check-json.sh # Fix JSON issues
40- ./scripts/validation/check-rust.sh # Fix Rust issues
41- ./src/target/release/format_md # Fix Markdown issues
51+ # Fix JSON formatting and validation issues
52+ ./src/target/release/check_json --fix
53+
54+ # Fix Rust formatting, run clippy, and tests
55+ ./scripts/validation/check-rust.sh
56+
57+ # Fix Markdown formatting (line length, spacing, etc.)
58+ ./src/target/release/format_md
59+
60+ # Check and optionally fix naming convention problems
61+ ./src/target/release/validate_naming --fix --verbose
4262```
4363
4464** See [ CONTRIBUTING.md] ( docs/CONTRIBUTING.md ) for complete development
@@ -94,14 +114,49 @@ embedding utilities):
94114# Build all Rust binaries
95115cd src && cargo build --release --features cli
96116
97- # Available binaries:
117+ # Available binaries in src/target/release/:
118+ # - check_json (JSON formatting and validation wrapper)
98119# - format_json (JSON formatting and validation)
99- # - validate_json_schema (Schema validation and generation)
120+ # - validate_json_schema (Schema validation and generation)
100121# - ingest_chunked (Character-based data ingestion)
101122# - embedding_tool (Embedding generation and testing)
102123# - text_chunker (Text processing utilities)
124+ # - format_md (Markdown formatting)
125+ # - validate_naming (Naming convention validation)
126+ # - status (System status checking)
127+ # - harald_ingest (Main ingestion tool)
128+ # - marvelai_ingest (Marvel-specific ingestion)
129+ ```
130+
131+ ### Using Rust Binaries
132+
133+ All binaries are located in ` src/target/release/ ` and should be run from the
134+ project root:
135+
136+ ``` bash
137+ # Format and validate JSON files
138+ ./src/target/release/check_json --fix
139+
140+ # Format Markdown files
141+ ./src/target/release/format_md path/to/file.md
142+
143+ # Validate naming conventions
144+ ./src/target/release/validate_naming --fix --verbose
145+
146+ # Check system status (Ollama services, models, etc.)
147+ ./src/target/release/status
148+
149+ # Process text for embedding
150+ ./src/target/release/text_chunker --input file.txt --mode char --size 250
151+
152+ # Run any tool with --help to see available options
153+ ./src/target/release/format_json --help
103154```
104155
156+ ** Note** : These Rust binaries have replaced the previous shell scripts for
157+ application logic. The old shell scripts in ` scripts/validation/ ` have been
158+ migrated to these type-safe, performant Rust implementations.
159+
105160### Deployment
106161
107162Deployment uses shell scripts for infrastructure orchestration:
@@ -130,6 +185,8 @@ handling.
130185
131186## Development Standards
132187
188+ - [ Development Principles] ( docs/DEVELOPMENT-PRINCIPLES.md ) - Core development
189+ principles and migration guidelines
133190- [ Naming Conventions] ( docs/naming-conventions.md ) - Standards for files and
134191 directories
135192- ** Build & Deploy** : Use ` ./scripts/deploy/deploy.sh ` for deployment (see
@@ -140,7 +197,6 @@ handling.
140197 Rust
141198- [ Project Structure] ( docs/migration/RECOMMENDED-STRUCTURE.md ) - Recommended
142199 organization
143- - [ Migration Documentation] ( docs/migration/ ) - Shell-to-Rust migration details
144200- ** Ingestion/Embedding Architecture:** All ingestion and embedding logic must
145201 follow the
146202 [ Modular Ingest Refactor Plan] ( docs/migration/INGEST-MIGRATION-MODULAR-PLAN.md ) .
0 commit comments