Skip to content

docs(docs): clean up implementation leaks, reorganize memory index, and expand synapse submodules - #292

Merged
sbharatjoshi merged 3 commits into
mainfrom
docs/spector-docs-cleanup
Jul 15, 2026
Merged

docs(docs): clean up implementation leaks, reorganize memory index, and expand synapse submodules#292
sbharatjoshi merged 3 commits into
mainfrom
docs/spector-docs-cleanup

Conversation

@sbharatjoshi

Copy link
Copy Markdown
Member

Summary of Changes

This Pull Request reorganizes the Spector OSS documentation in the core repository, cleans up leaked Java implementation details, substantially expands the synapse agentic documentation layer, and introduces theme-aware Mermaid styling.

1. Reorganized & Cleaned Up Cognitive Memory Docs

  • docs/docs/memory/index.md: Reordered the flagship Cognitive Memory landing page (Vision & Philosophy → 4-Tier Functional Model → Biological Metaphors → Advantages & Benchmarks → Deep Dives). Removed Java-specific references like Arena.ofShared() and FileChannel.map() from high-level summaries.
  • docs/docs/memory/cortex.md: Replaced technical details like FileChannel and mmap with functional/high-level descriptions.
  • docs/docs/memory/architecture.md: Standardized Custom Tier descriptions.

2. Expanded Synapse & Agentic Layer Documentation

  • docs/docs/synapse/index.md:
    • Removed AgentSoul class-level fields and UML class diagrams.
    • Documented the relationship between the Agent Soul (personality/governor) and the User Salience Profile (personalized retrieval filter) and how they complement each other.
    • Added functional descriptions and sequence/flow charts for submodules: Agentic Chat Graph, Dynamic Agent Execution (FlowSpec compiler), Memory Bridge, LLM Provider Registry, Data Connectors, and the Plugin System.
    • Added new operational sections for Observability & Tracing (thought/action/observation inspection), Failure Recovery & Loop Prevention, and Workflows vs. Autonomous Agents.

3. Theme-Aware Mermaid Styling

  • docs/docs/stylesheets/extra.css: Appended CSS class definitions matching Material theme variables for both slate (dark) and default (light) schemes.
  • Mapped all modified Mermaid diagrams to these new classes (e.g., :::working, :::episodic, :::synapse, :::cortex), removing all hardcoded style attributes.

Verification

  • Verified by compiling with mkdocs build, which succeeded in 2.84s with zero warnings/errors on modified files.
  • Verified local rendering by serving the site in the background.

…raphs from research to implemented

- HebbianGraph -> HebbianGraphCsr (CSR V3 layout, 90% memory reduction)
- EntityGraph max degree 32 -> 48, edge size 12B -> 16B (V2 with bridge/cycle metadata)
- Add Layer 4: HyperEntityGraph with full off-heap layout documentation
- Update architecture diagram from 3-layer to 4-layer
- Recalculate memory budget table with CSR numbers
- Mark hypergraphs as graduated in labs/roadmap.md priority matrix
- Add HyperEntityGraph to persistence table
@sbharatjoshi
sbharatjoshi merged commit 81a3fc5 into main Jul 15, 2026
4 checks passed
@jarvispectrayan
jarvispectrayan deleted the docs/spector-docs-cleanup branch July 15, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants