Github Pages (#234)

## Motivation and Context (Why the change? What's the scenario?)

Start documentation web site

## High level description (Approach, Design)

* Create site structure,
* Add Intro pages
* Fix minor bugs while parsing tags with trailing empty chars

.github/workflows/jekyll-gh-pages.yml

@@ -0,0 +1,51 @@
+# Sample workflow for building and deploying a Jekyll site to GitHub Pages
+name: Deploy Jekyll with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+      - name: Build with Jekyll
+        uses: actions/jekyll-build-pages@v1
+        with:
+          source: ./docs/
+          destination: ./_site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.vscode/settings.json

@@ -6,7 +6,7 @@
   "[csharp]": {
     "editor.defaultFormatter": "ms-dotnettools.csharp",
     "editor.codeActionsOnSave": {
-      "source.fixAll": true
+      "source.fixAll": "explicit"
     }
   },
   "editor.bracketPairColorization.enabled": true,

KernelMemory.sln

@@ -24,9 +24,31 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "clients", "clients", "{371B
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "docs", "docs", "{7BA7F1B2-19E2-46EB-B000-513EE2F65769}"
 	ProjectSection(SolutionItems) = preProject
-		docs\FAQ.md = docs\FAQ.md
-		docs\SECURITY_FILTERS.md = docs\SECURITY_FILTERS.md
+		docs\_config.local.yml = docs\_config.local.yml
+		docs\_config.yml = docs\_config.yml
+		docs\csharp.png = docs\csharp.png
+		docs\service.md = docs\service.md
+		docs\serverless.md = docs\serverless.md
+		docs\security.md = docs\security.md
+		docs\run.cmd = docs\run.cmd
+		docs\quickstart.md = docs\quickstart.md
+		docs\quickstart-swagger.png = docs\quickstart-swagger.png
+		docs\quickstart-dotnet-run.png = docs\quickstart-dotnet-run.png
+		docs\python.png = docs\python.png
+		docs\packages.md = docs\packages.md
 		docs\network.png = docs\network.png
+		docs\logo.png = docs\logo.png
+		docs\java.png = docs\java.png
+		docs\index.md = docs\index.md
+		docs\how-tos.md = docs\how-tos.md
+		docs\Gemfile.lock = docs\Gemfile.lock
+		docs\Gemfile = docs\Gemfile
+		docs\features.md = docs\features.md
+		docs\favicon.png = docs\favicon.png
+		docs\FAQ.md = docs\FAQ.md
+		docs\extensions.md = docs\extensions.md
+		docs\concepts.md = docs\concepts.md
+		docs\404.html = docs\404.html
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "examples", "examples", "{0A43C65C-6007-4BB4-B3FE-8D439FC91841}"

docs/.gitignore

@@ -0,0 +1,6 @@
+_site
+.sass-cache
+.jekyll-cache
+.jekyll-metadata
+vendor
+_setup.txt

docs/404.html

@@ -0,0 +1,25 @@
+---
+permalink: /404.html
+layout: default
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

docs/FAQ.md

@@ -1,3 +1,10 @@
+---
+nav_order: 90
+has_children: false
+title: F.A.Q.
+permalink: /faq
+layout: default
+---
 # Kernel Memory F.A.Q.
 
 ### How do I integrate Kernel Memory with my application?

docs/Gemfile

@@ -0,0 +1,48 @@
+source "https://rubygems.org"
+# Hello! This is where you manage which Jekyll version is used to run.
+# When you want to use a different version, change it below, save the
+# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
+#
+#     bundle exec jekyll serve
+#
+# This will help ensure the proper Jekyll version is running.
+# Happy Jekylling!
+gem "jekyll", "~> 4.3.3"
+# This is the default theme for new Jekyll sites. You may change this to anything you like.
+gem "minima", "~> 2.5"
+# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
+# uncomment the line below. To upgrade, run `bundle update github-pages`.
+# gem "github-pages", group: :jekyll_plugins
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem "jekyll-feed", "~> 0.12"
+end
+
+# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
+# do not have a Java counterpart.
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]
+
+gem "just-the-docs", "~> 0.7.0"
+
+# ====================================
+# source "https://rubygems.org"
+# gemspec
+
+# gem "jekyll", "~> 4.3.3"
+# gem "just-the-docs", "~> 0.7.0"
+
+# gem "jekyll-github-metadata", ">= 2.15"
+
+# gem "jekyll-include-cache", group: :jekyll_plugins
+
+# gem "html-proofer", "~> 5.0", :group => :development

docs/Gemfile.lock

@@ -0,0 +1,98 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.2.2)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.16.3)
+    forwardable-extended (2.6.0)
+    google-protobuf (3.25.1)
+    google-protobuf (3.25.1-x86_64-darwin)
+    http_parser.rb (0.8.0)
+    i18n (1.14.1)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.3.3)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (>= 2.0, < 4.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3, >= 2.3.1)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (>= 0.3.6, < 0.5)
+      pathutil (~> 0.9)
+      rouge (>= 3.0, < 5.0)
+      safe_yaml (~> 1.0)
+      terminal-table (>= 1.8, < 4.0)
+      webrick (~> 1.7)
+    jekyll-feed (0.17.0)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-include-cache (0.2.1)
+      jekyll (>= 3.7, < 5.0)
+    jekyll-sass-converter (3.0.0)
+      sass-embedded (~> 1.54)
+    jekyll-seo-tag (2.8.0)
+      jekyll (>= 3.8, < 5.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    just-the-docs (0.7.0)
+      jekyll (>= 3.8.5)
+      jekyll-include-cache
+      jekyll-seo-tag (>= 2.0)
+      rake (>= 12.3.1)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.4)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    minima (2.5.1)
+      jekyll (>= 3.5, < 5.0)
+      jekyll-feed (~> 0.9)
+      jekyll-seo-tag (~> 2.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (5.0.4)
+    rake (13.1.0)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.6)
+    rouge (4.2.0)
+    safe_yaml (1.0.5)
+    sass-embedded (1.69.6)
+      google-protobuf (~> 3.25)
+      rake (>= 13.0.0)
+    sass-embedded (1.69.6-x86_64-darwin)
+      google-protobuf (~> 3.25)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+
+PLATFORMS
+  ruby
+  x86_64-darwin-23
+
+DEPENDENCIES
+  http_parser.rb (~> 0.6.0)
+  jekyll (~> 4.3.3)
+  jekyll-feed (~> 0.12)
+  just-the-docs (~> 0.7.0)
+  minima (~> 2.5)
+  tzinfo (>= 1, < 3)
+  tzinfo-data
+  wdm (~> 0.1.1)
+
+BUNDLED WITH
+   2.5.3

docs/_config.local.yml

@@ -0,0 +1,82 @@
+# Config for local Jekyll tests
+theme: just-the-docs
+
+# ==================================================
+# == everything below is the same as _config.yaml ==
+# ==================================================
+
+title: Kernel Memory
+description: >-
+  Index and query any data using LLM and natural language, tracking sources and
+  showing citations. Kernel Memory (KM) is a multi-modal AI Service specialized
+  in the efficient indexing of datasets through custom continuous data hybrid
+  pipelines, with support for Retrieval Augmented Generation (RAG), synthetic
+  memory, prompt engineering, and custom semantic memory processing.
+baseurl: "/kernel-memory"
+url: ""
+
+favicon_ico: "/favicon.png"
+enable_copy_code_button: true
+heading_anchors: true
+color_scheme: custom
+
+callouts:
+  highlight:
+    color: yellow
+  console:
+    color: green
+  important:
+    title: Important
+    color: blue
+  new:
+    title: New
+    color: green
+  note:
+    title: Note
+    color: purple
+  warning:
+    title: Warning
+    color: red
+
+nav_external_links:
+  - title: KM on GitHub
+    url: https://github.com/microsoft/kernel-memory
+  - title: KM on Discord
+    url: https://aka.ms/KMDiscord
+
+aux_links:
+  "GitHub":
+    - "https://github.com/microsoft/kernel-memory"
+  "Discord":
+    - "https://aka.ms/KMDiscord"
+
+back_to_top: false
+back_to_top_text: "Back to top"
+
+gh_edit_link: true
+gh_edit_link_text: "Edit this page"
+gh_edit_repository: "https://github.com/microsoft/kernel-memory"
+gh_edit_branch: "main"
+gh_edit_source: docs
+gh_edit_view_mode: "tree"
+
+search_enabled: true
+search:
+  # Split pages into sections that can be searched individually # Supports 1 - 6, default: 6
+  heading_level: 6
+  # Maximum amount of previews per search result # Default: 3
+  previews: 3
+  # Maximum amount of words to display before a matched word in the preview # Default: 5
+  preview_words_before: 6
+  # Maximum amount of words to display after a matched word in the preview # Default: 10
+  preview_words_after: 10
+  # Set the search token separator # Default: /[\s\-/]+/ # Example: enable support for hyphenated search words
+  tokenizer_separator: /[\s/]+/
+  # Display the relative url in search results # Supports true (default) or false
+  rel_url: false
+  # Enable or disable the search button that appears in the bottom right corner of every page # Supports true or false (default)
+  button: true
+
+mermaid:
+  # See https://cdn.jsdelivr.net/npm/mermaid/
+  version: "10.6.1"