Add docs pages, remove useless submodules (#44)

* add mkdocs library for docs

* fix deploy config

* Update docs, remove useless submodules

Author: bachish

.github/dependabot.yml

@@ -0,0 +1,32 @@
+name: ci
+on:
+  push:
+    branches:
+      - main
+      - bachish/add-docs-pages
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: ~/.cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

.github/workflows/build.yml

@@ -2,6 +2,8 @@
 
 > Note: project under heavy development!
 
+Please, see [documentation](https://formallanguageconstrainedpathquerying.github.io/UCFS/) for details.
+
 ## What is UCFS?
 
 UCFS is an **U**niversal **C**ontext-**F**ree **S**olver: a GLL‑based tool for problems at the intersection of context‑free languages 
@@ -22,12 +24,11 @@ over edge‑labeled directed graphs. Examples of such problems:
 
 ### Repository layout (high‑level)
 ```
-benchmarks/   # ANTLR4 comparison & perf harness (examples, scripts)
-examples/     # Grammar examples (A*, Dyck, etc.)
-generator/    # Parser & AST node‑class generator
+docs/         # documentation pages  
+generator/    # Parser & AST node‑class generator <in progress>
 solver/       # Core UCFS logic (GLL + RSM)
-src/          # CLI and library entry points
-test-shared/  # Testcases, grammars, inputs
+test-shared/  # Testcases, grammars, inputs, ANTLR4 comparison
+              # grammar examples and experiments
 ```
 
 ### Requirements
@@ -42,4 +43,4 @@ test-shared/  # Testcases, grammars, inputs
 
 
 ## Core Algorithm
-UCFS is based on Generalized LL (GLL) parsing algorithm modified to handle language specification in form of Recursive State Machines (RSM-s) and input in form of arbitratry directed edge-labelled graph. Basic ideas described [here](https://arxiv.org/pdf/2312.11925.pdf). 
+UCFS is based on Generalized LL (GLL) parsing algorithm modified to handle language specification in form of Recursive State Machines (RSM) and input in form of arbitratry directed edge-labelled graph. Basic ideas described [here](https://arxiv.org/pdf/2312.11925.pdf).