kbs 0.0.1 → 0.2.0

data/mkdocs.yml

@@ -0,0 +1,181 @@
+# MkDocs Configuration for KBS Documentation
+site_name: KBS - Knowledge-Based Systems for Ruby
+site_description: A Ruby implementation of the RETE algorithm for production rule systems with persistent blackboard memory
+site_author: Dewayne VanHoozer
+site_url: https://madbomber.github.io/kbs
+copyright: Copyright © 2024 Dewayne VanHoozer
+
+# Repository information
+repo_name: madbomber/kbs
+repo_url: https://github.com/madbomber/kbs
+edit_uri: edit/main/docs/
+
+# Configuration
+theme:
+  name: material
+
+  # Color scheme - Default to light mode
+  palette:
+    # Palette toggle for light mode (default)
+    - scheme: default
+      primary: deep purple
+      accent: purple
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      primary: deep purple
+      accent: purple
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  # Typography
+  font:
+    text: Roboto
+    code: Roboto Mono
+
+  # Theme features
+  features:
+    # Navigation
+    - navigation.instant
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.path
+    - navigation.indexes
+    - navigation.top
+
+    # Table of contents
+    - toc.follow
+
+    # Search
+    - search.suggest
+    - search.highlight
+    - search.share
+
+    # Header
+    - header.autohide
+
+    # Content
+    - content.code.copy
+    - content.code.annotate
+    - content.tabs.link
+    - content.tooltips
+    - content.action.edit
+    - content.action.view
+
+# Plugins
+plugins:
+  - search:
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+
+# Extensions
+markdown_extensions:
+  # Python Markdown
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - toc:
+      permalink: true
+      title: On this page
+
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.magiclink:
+      repo_url_shorthand: true
+      user: madbomber
+      repo: kbs
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+# Extra CSS and JavaScript
+extra_css:
+  - assets/css/custom.css
+
+extra_javascript:
+  - assets/js/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
+
+# Social media and extra configuration
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/madbomber/kbs
+      name: KBS on GitHub
+    - icon: fontawesome/solid/gem
+      link: https://rubygems.org/gems/kbs
+      name: KBS on RubyGems
+
+  version:
+    provider: mike
+
+# Navigation
+nav:
+  - Home:
+      - index.md
+      - What is aKnowledge Base?: what-is-a-knowledge-base.md
+      - What is a Fact?: what-is-a-fact.md
+      - What is a Rule?: what-is-a-rule.md
+  - Installation: installation.md
+  - Quick Start: quick-start.md
+  - Architecture:
+      - architecture/index.md
+      - RETE Algorithm: architecture/rete-algorithm.md
+      - Blackboard System: architecture/blackboard.md
+      - Network Structure: architecture/network-structure.md
+  - Guides:
+      - guides/index.md
+      - Getting Started: guides/getting-started.md
+      - Writing Rules: guides/writing-rules.md
+      - DSL Reference: guides/dsl.md
+      - Working with Facts: guides/facts.md
+      - Pattern Matching: guides/pattern-matching.md
+      - Variable Binding: guides/variable-binding.md
+      - Negation: guides/negation.md
+      - Blackboard Memory: guides/blackboard-memory.md
+      - Persistence Options: guides/persistence.md
+  - Examples: examples/index.md
+  - Advanced:
+      - advanced/index.md
+      - Performance Tuning: advanced/performance.md
+      - Custom Persistence: advanced/custom-persistence.md
+      - Debugging: advanced/debugging.md
+      - Testing Rules: advanced/testing.md
+  - API Reference:
+      - api/index.md
+      - ReteEngine: api/engine.md
+      - Facts: api/facts.md
+      - Rules: api/rules.md
+      - Blackboard: api/blackboard.md

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kbs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Dewayne VanHoozer
@@ -13,14 +13,14 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -68,7 +68,7 @@ dependencies:
 description: |
   A comprehensive Ruby implementation of a Knowledge-Based System featuring:
 
-  • RETE II Algorithm: Optimized forward-chaining inference engine with unlinking optimization for high-performance pattern matching
+  • RETE Algorithm: Optimized forward-chaining inference engine with unlinking optimization for high-performance pattern matching
   • Declarative DSL: Readable, expressive syntax for rule definition with built-in condition helpers
   • Blackboard Architecture: Multi-agent coordination with message passing and knowledge source registration
   • Flexible Persistence: SQLite (durable), Redis (fast), and hybrid storage backends with audit trails
@@ -84,27 +84,90 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".envrc"
+- ".github/workflows/deploy-github-pages.yml"
 - CHANGELOG.md
 - COMMITS.md
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/advanced/custom-persistence.md
+- docs/advanced/debugging.md
+- docs/advanced/index.md
+- docs/advanced/performance.md
+- docs/advanced/testing.md
+- docs/api/blackboard.md
+- docs/api/engine.md
+- docs/api/facts.md
+- docs/api/index.md
+- docs/api/rules.md
+- docs/architecture/blackboard.md
+- docs/architecture/index.md
+- docs/architecture/network-structure.md
+- docs/architecture/rete-algorithm.md
+- docs/assets/css/custom.css
+- docs/assets/images/blackboard-architecture.svg
+- docs/assets/images/compiled-network.svg
+- docs/assets/images/fact-assertion-flow.svg
+- docs/assets/images/fact-rule-relationship.svg
+- docs/assets/images/fact-structure.svg
+- docs/assets/images/inference-cycle.svg
+- docs/assets/images/kb-components.svg
+- docs/assets/images/kbs.jpg
+- docs/assets/images/pattern-matching-trace.svg
+- docs/assets/images/rete-network-layers.svg
+- docs/assets/images/rule-structure.svg
+- docs/assets/images/system-layers.svg
+- docs/assets/images/trading-signal-network.svg
+- docs/assets/js/mathjax.js
+- docs/examples/index.md
+- docs/guides/blackboard-memory.md
+- docs/guides/dsl.md
+- docs/guides/facts.md
+- docs/guides/getting-started.md
+- docs/guides/index.md
+- docs/guides/negation.md
+- docs/guides/pattern-matching.md
+- docs/guides/persistence.md
+- docs/guides/variable-binding.md
+- docs/guides/writing-rules.md
+- docs/index.md
+- docs/installation.md
+- docs/quick-start.md
+- docs/what-is-a-fact.md
+- docs/what-is-a-knowledge-base.md
+- docs/what-is-a-rule.md
+- examples/.gitignore
 - examples/README.md
 - examples/advanced_example.rb
+- examples/advanced_example_dsl.rb
 - examples/ai_enhanced_kbs.rb
+- examples/ai_enhanced_kbs_dsl.rb
 - examples/blackboard_demo.rb
+- examples/blackboard_demo_dsl.rb
 - examples/car_diagnostic.rb
+- examples/car_diagnostic_dsl.rb
 - examples/concurrent_inference_demo.rb
+- examples/concurrent_inference_demo_dsl.rb
 - examples/csv_trading_system.rb
+- examples/csv_trading_system_dsl.rb
 - examples/iot_demo_using_dsl.rb
 - examples/portfolio_rebalancing_system.rb
+- examples/portfolio_rebalancing_system_dsl.rb
 - examples/redis_trading_demo.rb
+- examples/redis_trading_demo_dsl.rb
+- examples/rule_source_demo.rb
+- examples/run_all.rb
+- examples/run_all_dsl.rb
 - examples/sample_stock_data.csv
 - examples/stock_trading_advanced.rb
-- examples/stock_trading_system.rb.bak
+- examples/stock_trading_advanced_dsl.rb
+- examples/temp_dsl.txt
 - examples/timestamped_trading.rb
+- examples/timestamped_trading_dsl.rb
 - examples/trading_demo.rb
+- examples/trading_demo_dsl.rb
 - examples/working_demo.rb
+- examples/working_demo_dsl.rb
 - lib/kbs.rb
 - lib/kbs/alpha_memory.rb
 - lib/kbs/beta_memory.rb
@@ -121,21 +184,23 @@ files:
 - lib/kbs/blackboard/redis_audit_log.rb
 - lib/kbs/blackboard/redis_message_queue.rb
 - lib/kbs/condition.rb
+- lib/kbs/decompiler.rb
 - lib/kbs/dsl.rb
 - lib/kbs/dsl/condition_helpers.rb
 - lib/kbs/dsl/knowledge_base.rb
 - lib/kbs/dsl/pattern_evaluator.rb
 - lib/kbs/dsl/rule_builder.rb
 - lib/kbs/dsl/variable.rb
+- lib/kbs/engine.rb
 - lib/kbs/fact.rb
 - lib/kbs/join_node.rb
 - lib/kbs/negation_node.rb
 - lib/kbs/production_node.rb
-- lib/kbs/rete_engine.rb
 - lib/kbs/rule.rb
 - lib/kbs/token.rb
 - lib/kbs/version.rb
 - lib/kbs/working_memory.rb
+- mkdocs.yml
 homepage: https://github.com/madbomber/kbs
 licenses:
 - MIT
@@ -157,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.7
 specification_version: 4
-summary: Production-ready Knowledge-Based System with RETE II inference, Blackboard
-  architecture, and AI integration
+summary: Knowledge-Based System with RETE inference, Blackboard architecture, and
+  AI integration
 test_files: []