fix: use mike wip; update contributors

fix: rename

fix: mike config

fix: macros config wip

fix: resolve warnings

fix: add template schema

Author: Udayraj123

.github/workflows/gh-deploy.yml .github/workflows/deploy_mkdocs.yml.github/workflows/gh-deploy.yml renamed to .github/workflows/deploy_mkdocs.yml

@@ -1,16 +1,30 @@
-name: Docs
+name: Deploy MkDocs
 
 on:
   push:
-    branches: [master]
+    branches:
+      - master
+      - dev
+      - feature/mkdocs-debug # temp
+
   pull_request:
     branches: [master]
 
 permissions:
   contents: write
 
+env:
+  IS_NOT_A_FORK: ${{ github.event.pull_request.head.repo.fork == false }}
+  IS_PULL_REQUEST: ${{ github.event_name == 'pull_request' }}
+  IS_PUSH: ${{ github.event_name == 'push' }}
+  BRANCH_NAME: ${{ github.ref_name }}
+  IS_MASTER: ${{ BRANCH_NAME == 'master' }}
+  IS_DEV: ${{ BRANCH_NAME == 'dev' }}
+  MIKE_DEPLOY_VERSION: ${{ $IS_MASTER && '1.x' || ($IS_DEV && '2.x' || '$BRANCH_NAME') }}
+
 jobs:
   deploy:
+    if: ${{ ($IS_PUSH || $IS_NOT_A_FORK) && $MIKE_DEPLOY_VERSION != '' }}
     runs-on: ubuntu-latest
 
     steps:
@@ -38,4 +52,4 @@ jobs:
           path: .cache
           restore-keys: mkdocs-material-
 
-      - run: uv run mkdocs gh-deploy --force
+      - run: uv run mike deploy "$MIKE_DEPLOY_VERSION"

.gitignore

@@ -8,7 +8,7 @@
 !docs/overrides/.icons
 
 # mkdocs generated site
-docs/site
+site/
 
 # Everything in inputs/ and outputs/
 inputs/*

CONTRIBUTING.md

@@ -15,15 +15,23 @@ Also, try to use commits with [conventional messages](https://www.conventionalco
 
 
 # Code Formatting
-Before committing your code, make sure to run the following command to format your code according to the PEP8 style guide:
-```.sh
-pip install -r requirements.dev.txt && pre-commit install
+Make sure to run uv ruff check (with optionally --fix) to format your code
+```
+uv ruff check
 ```
 
-Run `pre-commit` before committing your changes:
-```.sh
-git add .
-pre-commit run -a
+# Documentation
+- Update Contributors.md file with your name
+- Any changes in the functionality of the tool, especially in the configuration schema should be documented. For documentation we are using mike(internally uses mkdocs).
+- To view documentation site locally, use mike:
+```bash
+# https://github.com/mkdocs-material/example-versioning/blob/master/README.md
+# List versions -
+uv run mike list
+# Update and commit given version's docs in the gh-pages branch
+uv run mike deploy <version>
+# Serve the docs
+uv run mike serve
 ```
 
 # Where to contribute from

Contributors.md

@@ -1,23 +1,35 @@
 # Contributors
 
-- [Udayraj123](https://github.com/Udayraj123)
-- [leongwaikay](https://github.com/leongwaikay)
-- [deepakgouda](https://github.com/deepakgouda)
-- [apurva91](https://github.com/apurva91)
-- [sparsh2706](https://github.com/sparsh2706)
-- [namit2saxena](https://github.com/namit2saxena)
-- [Harsh-Kapoorr](https://github.com/Harsh-Kapoorr)
-- [Sandeep-1507](https://github.com/Sandeep-1507)
-- [SpyzzVVarun](https://github.com/SpyzzVVarun)
-- [asc249](https://github.com/asc249)
 - [05Alston](https://github.com/05Alston)
+- [aayushibansal2001](https://github.com/aayushibansal2001)
 - [Antibodyy](https://github.com/Antibodyy)
+- [apurva91](https://github.com/apurva91)
+- [aqoshi](https://github.com/aqoshi)
+- [asc249](https://github.com/asc249)
+- [benjiforster](https://github.com/benjiforster)
+- [deepakgouda](https://github.com/deepakgouda)
+- [Drita-ai](https://github.com/Drita-ai)
+- [Dxuian](https://github.com/Dxuian)
+- [gaursagar21](https://github.com/gaursagar21)
+- [Harsh-Kapoorr](https://github.com/Harsh-Kapoorr)
 - [infinity1729](https://github.com/infinity1729)
-- [Rohan-G](https://github.com/Rohan-G)
-- [UjjwalMahar](https://github.com/UjjwalMahar)
+- [juliangilbey](https://github.com/juliangilbey)
 - [Kurtsley](https://github.com/Kurtsley)
-- [gaursagar21](https://github.com/gaursagar21)
-- [aayushibansal2001](https://github.com/aayushibansal2001)
-- [ShamanthVallem](https://github.com/ShamanthVallem)
-- [rudrapsc](https://github.com/rudrapsc)
+- [leongwaikay](https://github.com/leongwaikay)
+- [namit2saxena](https://github.com/namit2saxena)
 - [palash018](https://github.com/palash018)
+- [pixalquarks](https://github.com/pixalquarks)
+- [Princekumarofficial](https://github.com/Princekumarofficial)
+- [Rohan-G](https://github.com/Rohan-G)
+- [rudrapsc](https://github.com/rudrapsc)
+- [samuelIkoli](https://github.com/samuelIkoli)
+- [Sandeep-1507](https://github.com/Sandeep-1507)
+- [sandptel](https://github.com/sandptel)
+- [ShamanthVallem](https://github.com/ShamanthVallem)
+- [sparsh2706](https://github.com/sparsh2706)
+- [SpyzzVVarun](https://github.com/SpyzzVVarun)
+- [theranjitraut](https://github.com/theranjitraut)
+- [Udayraj123](https://github.com/Udayraj123)
+- [UjjwalMahar](https://github.com/UjjwalMahar)
+
+[Github Contributors](https://github.com/Udayraj123/OMRChecker/graphs/contributors)

README.md

@@ -23,8 +23,8 @@ OMR stands for Optical Mark Recognition, used to detect and interpret human-mark
 <!-- [![GitHub contributors](https://img.shields.io/github/contributors/Udayraj123/OMRChecker.svg)](https://GitHub.com/Udayraj123/OMRChecker/graphs/contributors/) -->
 
 [![GitHub stars](https://img.shields.io/github/stars/Udayraj123/OMRChecker.svg?style=social&label=Stars✯)](https://GitHub.com/Udayraj123/OMRChecker/stargazers/)
-[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FUdayraj123%2FOMRChecker&count_bg=%2379C83D&title_bg=%23555555&icon=googlecast.svg&icon_color=%23E7E7E7&title=hits%2829.09.2022%29&edge_flat=false)](https://hits.seeyoufarm.com)
-[![Join](https://img.shields.io/badge/Join-Discord_group-purple.svg?style=flat-square)](https://discord.gg/qFv2Vqf)
+<!-- [![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2FUdayraj123%2FOMRChecker&count_bg=%2379C83D&title_bg=%23555555&icon=googlecast.svg&icon_color=%23E7E7E7&title=hits%2829.09.2022%29&edge_flat=false)](https://hits.seeyoufarm.com) -->
+
 
 <!-- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/gist/Udayraj123/a125b1531c61cceed5f06994329cba66/omrchecker-on-cloud.ipynb) -->
 
@@ -241,8 +241,6 @@ This project was born out of a student-led organization called as [Technothlon](
 
 We believe in the power of open source! Currently, OMRChecker is in an intermediate stage where only developers can use it. We hope to see it become more user-friendly as well as robust from exposure to different inputs from you all!
 
-[![Open Source](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
-
 </details>
 
 <details>
@@ -252,33 +250,19 @@ We believe in the power of open source! Currently, OMRChecker is in an intermedi
 
 OMRChecker can be forked and modified. You are encouraged to play with it and we would love to see your own projects in action!
 
-It is published under the [MIT license](https://github.com/Udayraj123/OMRChecker/blob/master/LICENSE).
+It is published under the MIT license.
 
 </details>
 
-<details>
-<summary>
-<b>What are the ways to contribute?</b>
-</summary>
-
-- Join the developer community on [Discord](https://discord.gg/qFv2Vqf) to fix [issues](https://github.com/Udayraj123/OMRChecker/issues) with OMRChecker.
-
-- If this project saved you some costs on OMR Software licenses, or saved efforts to make one. Consider donating an amount of your choice(donate section).
-
-<!-- ![☕](https://miro.medium.com/fit/c/256/256/1*br7aoq_JVfxeg73x5tF_Sw.png) -->
-<!-- [![paypal.me](https://www.paypalobjects.com/en_GB/i/btn/btn_donate_SM.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=Z5BNNK7AVFVH8&source=url) -->
-<!-- https://www.amazon.in/hz/wishlist/ls/3V0TDQBI3T8IL -->
-
-</details>
 
 ## Credits
 
 _A Huge thanks to:_
-_**Adrian Rosebrock** for his exemplary blog:_ https://pyimagesearch.com
+_**Adrian Rosebrock** for his exemplary blog:_ [https://pyimagesearch.com](https://pyimagesearch.com)
 
 _**Harrison Kinsley** aka sentdex for his [video tutorials](https://www.youtube.com/watch?v=Z78zbnLlPUA&list=PLQVvvaa0QuDdttJXlLtAJxJetJcqmqlQq) and many other resources._
 
-_**Satya Mallic** for his resourceful blog:_ https://www.learnopencv.com
+_**Satya Mallic** for his resourceful blog:_ [https://www.learnopencv.com](https://www.learnopencv.com)
 
 _And to other amazing people from all over the globe who've made significant improvements in this project._
 
@@ -294,6 +278,9 @@ Here's a snapshot of the [Android OMR Helper App (archived)](https://github.com/
 	</a>
 </p>
 
+## External Links
+- Deepwiki Docs(Devin): [https://deepwiki.com/Udayraj123/OMRChecker](https://deepwiki.com/Udayraj123/OMRChecker)
+
 ## Stargazers over time
 
 [![Stargazers over time](https://starchart.cc/Udayraj123/OMRChecker.svg)](https://starchart.cc/Udayraj123/OMRChecker)