Documentation on github pages

.config/.cspell.json

@@ -9,7 +9,7 @@
         "zwifters"
     ],
     "files": [
-        "README.md"
+        "**/*.md"
     ],
     "languageSettings": [
         {

.config/.markdownlint-cli2.jsonc

@@ -10,10 +10,13 @@
         "no-duplicate-heading": {
             "siblings_only": true
         },
-        "no-inline-html": false
+        "no-inline-html": false,
+        "single-title": {
+            "front_matter_title": ""
+        }
     },
     "gitignore": true,
     "globs": [
-        "README.md"
+        "**/*.md"
     ]
 }

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,24 +4,29 @@ about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: netbrain
-
 ---
 
-**Describe the bug**
+## Describe the bug
+
 A clear and concise description of what the bug is.
 
-**To Reproduce**
+## To Reproduce
+
 Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
+
+1. Go to `...`
+2. Click on `...`
+3. Scroll down to `...`
 4. See error
 
-**Expected behavior**
+## Expected behavior
+
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
+## Screenshots
+
 If applicable, add screenshots to help explain your problem.
 
-**Additional context**
+## Additional context
+
 Add any other context about the problem here.

.github/workflows/github_pages.yaml

@@ -0,0 +1,55 @@
+name: Build Jekyll site
+on:
+  push:
+    branches:
+      - 'gp-docs'
+    paths:
+      - '.github/workflows/github_pages.yaml'
+      - 'docs/**'
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout repository code
+        uses: actions/checkout@v6
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+          cache-version: 0
+          working-directory: '${{ github.workspace }}/docs'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        run: |
+          bundle install
+          bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: docs/_site
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to github pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/lint_readme.yaml → .github/workflows/lint_markdown.yaml

@@ -2,27 +2,27 @@ name: Validate markdown
 on:
   pull_request:
     paths:
-      - 'README.md'
+      - '**.md'
   push:
     paths:
-      - 'README.md'
+      - '**.md'
 jobs:
-  validate-readme-markdown:
+  validate-markdown:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository code
         uses: actions/checkout@v5
-      - name: Check README.md file for errors
+      - name: Check markdown files for errors
         uses: DavidAnson/markdownlint-cli2-action@v20
         with:
           config: '.config/.markdownlint-cli2.jsonc'
           globs: ""
-  spellcheck-readme:
+  spellcheck-markdown:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository code
         uses: actions/checkout@v5
-      - name: Spellcheck README.md
+      - name: Spellcheck markdown files
         uses: streetsidesoftware/cspell-action@v7
         with:
           config: '.config/.cspell.json'

docs/.gitignore

@@ -0,0 +1,15 @@
+# Not sure what a .gitignore is?
+# See: https://git-scm.com/docs/gitignore
+
+# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
+# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
+
+# Ignore the default location of the built site, and caches and metadata generated by Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+
+# Ignore folders generated by Bundler
+.bundle/
+vendor/

docs/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem "jekyll", "~> 4.4.1"
+gem "jekyll-coffeescript"
+gem "jekyll-default-layout"
+gem "jekyll-gist"
+gem "jekyll-github-metadata"
+gem "jekyll-optional-front-matter"
+gem "jekyll-paginate"
+gem "jekyll-readme-index"
+gem "jekyll-titles-from-headings"
+gem "jekyll-relative-links"
+gem "jemoji"
+gem "just-the-docs"