Update docs and onboard none-shall-pass

.github/workflows/markdown.yaml

@@ -0,0 +1,13 @@
+name: none-shall-pass
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  none-shall-pass:
+    runs-on: thevickypedia-lite
+    steps:
+      - uses: thevickypedia/none-shall-pass@v5

README.md

@@ -11,6 +11,7 @@ Backup GitHub projects to AWS S3
 
 [![pages][label-actions-pages]][gha_pages]
 [![pypi][label-actions-pypi]][gha_pypi]
+[![markdown][label-actions-markdown]][gha_md_valid]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -89,9 +90,10 @@ pre-commit run --all-files
 © Vignesh Rao
 
 Licensed under the [MIT License][license]
-    
+
 [//]: # (Labels)
 
+[label-actions-markdown]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml/badge.svg
 [label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-git2s3-blue?style=for-the-badge&logo=Python
 [label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
 [label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange
@@ -108,6 +110,7 @@ Licensed under the [MIT License][license]
 [release-notes]: https://github.com/thevickypedia/git2s3/blob/master/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml
+[gha_md_valid]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/

docs/README.html

@@ -51,10 +51,11 @@ <h1>Git2S3<a class="headerlink" href="#git2s3" title="Permalink to this heading"
 <p><img alt="Platform" src="https://img.shields.io/badge/Platform-Linux%7CmacOS%7CWindows-1f425f.svg" /></p>
 <p><strong>Deployments</strong></p>
 <p><a class="reference external" href="https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment"><img alt="pages" src="https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg" /></a>
-<a class="reference external" href="https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml"><img alt="pypi" src="https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg" /></a></p>
-<p><a class="reference external" href="https://pypi.org/project/Git2S3"><img alt="Pypi" src="https://img.shields.io/pypi/v/git2s3" /></a>
-<a class="reference external" href="https://pypi.org/project/Git2S3/#files"><img alt="Pypi-format" src="https://img.shields.io/pypi/format/Git2S3" /></a>
-<a class="reference external" href="https://pypi.org/project/Git2S3"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/Git2S3" /></a></p>
+<a class="reference external" href="https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml"><img alt="pypi" src="https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml"><img alt="markdown" src="https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml/badge.svg" /></a></p>
+<p><a class="reference external" href="https://pypi.org/project/git2s3"><img alt="Pypi" src="https://img.shields.io/pypi/v/git2s3" /></a>
+<a class="reference external" href="https://pypi.org/project/git2s3/#files"><img alt="Pypi-format" src="https://img.shields.io/pypi/format/git2s3" /></a>
+<a class="reference external" href="https://pypi.org/project/git2s3"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/git2s3" /></a></p>
 <section id="kick-off">
 <h2>Kick off<a class="headerlink" href="#kick-off" title="Permalink to this heading">¶</a></h2>
 <p><strong>Recommendations</strong></p>
@@ -80,7 +81,7 @@ <h2>Kick off<a class="headerlink" href="#kick-off" title="Permalink to this head
 </pre></div>
 </div>
 <blockquote>
-<div><p>Use <code class="docutils literal notranslate"><span class="pre">Git2S3</span> <span class="pre">--help</span></code> for usage instructions.</p>
+<div><p>Use <code class="docutils literal notranslate"><span class="pre">git2s3</span> <span class="pre">--help</span></code> for usage instructions.</p>
 </div></blockquote>
 </section>
 <section id="coding-standards">
@@ -89,7 +90,7 @@ <h2>Coding Standards<a class="headerlink" href="#coding-standards" title="Permal
 Styling conventions: <a class="reference external" href="https://www.python.org/dev/peps/pep-0008/"><code class="docutils literal notranslate"><span class="pre">PEP</span> <span class="pre">8</span></code></a> and <a class="reference external" href="https://pycqa.github.io/isort/"><code class="docutils literal notranslate"><span class="pre">isort</span></code></a></p>
 </section>
 <section id="release-notes">
-<h2><a class="reference external" href="https://github.com/thevickypedia/Git2S3/blob/master/release_notes.rst">Release Notes</a><a class="headerlink" href="#release-notes" title="Permalink to this heading">¶</a></h2>
+<h2><a class="reference external" href="https://github.com/thevickypedia/git2s3/blob/master/release_notes.rst">Release Notes</a><a class="headerlink" href="#release-notes" title="Permalink to this heading">¶</a></h2>
 <p><strong>Requirement</strong></p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>gitverse
 </pre></div>
@@ -114,19 +115,19 @@ <h2>Linting<a class="headerlink" href="#linting" title="Permalink to this headin
 </section>
 <section id="pypi-package">
 <h2>Pypi Package<a class="headerlink" href="#pypi-package" title="Permalink to this heading">¶</a></h2>
-<p><a class="reference external" href="https://packaging.python.org/tutorials/packaging-projects/"><img alt="pypi-module" src="https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg" /></a></p>
-<p><a class="reference external" href="https://pypi.org/project/Git2S3">https://pypi.org/project/Git2S3/</a></p>
+<p><a class="reference external" href="https://packaging.python.org/tutorials/packaging-projects/"><img alt="pypi-module" src="https://img.shields.io/badge/Pypi%20Package-git2s3-blue?style=for-the-badge&amp;logo=Python" /></a></p>
+<p><a class="reference external" href="https://pypi.org/project/git2s3">https://pypi.org/project/git2s3/</a></p>
 </section>
 <section id="runbook">
 <h2>Runbook<a class="headerlink" href="#runbook" title="Permalink to this heading">¶</a></h2>
-<p><a class="reference external" href="https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html"><img alt="made-with-sphinx-doc" src="https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg" /></a></p>
-<p><a class="reference external" href="https://Git2S3-docs.vigneshrao.com/">https://Git2S3-docs.vigneshrao.com/</a></p>
+<p><a class="reference external" href="https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html"><img alt="made-with-sphinx-doc" src="https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&amp;logo=Sphinx" /></a></p>
+<p><a class="reference external" href="https://thevickypedia.github.io/git2s3/">https://thevickypedia.github.io/git2s3/</a></p>
 </section>
 <section id="license-copyright">
 <h2>License &amp; copyright<a class="headerlink" href="#license-copyright" title="Permalink to this heading">¶</a></h2>
 <p>© Vignesh Rao</p>
-<p>Licensed under the <a class="reference external" href="https://github.com/thevickypedia/Git2S3/blob/master/LICENSE">MIT License</a></p>
-<!-- labels --></section>
+<p>Licensed under the <a class="reference external" href="https://github.com/thevickypedia/git2s3/blob/master/LICENSE">MIT License</a></p>
+</section>
 </section>
 
 

docs/README.md

@@ -11,6 +11,7 @@ Backup GitHub projects to AWS S3
 
 [![pages][label-actions-pages]][gha_pages]
 [![pypi][label-actions-pypi]][gha_pypi]
+[![markdown][label-actions-markdown]][gha_md_valid]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -43,7 +44,7 @@ if __name__ == '__main__':
 git2s3 start
 ```
 
-> Use `Git2S3 --help` for usage instructions.
+> Use `git2s3 --help` for usage instructions.
 
 ## Coding Standards
 Docstring format: [`Google`][google-docs] <br>
@@ -75,101 +76,47 @@ pre-commit run --all-files
 ```
 
 ## Pypi Package
-[![pypi-module](https://img.shields.io/badge/Software%20Repository-pypi-1f425f.svg)][pypi-repo]
+[![pypi-module][label-pypi-package]][pypi-repo]
 
-[https://pypi.org/project/Git2S3/][pypi]
+[https://pypi.org/project/git2s3/][pypi]
 
 ## Runbook
-[![made-with-sphinx-doc](https://img.shields.io/badge/Code%20Docs-Sphinx-1f425f.svg)][sphinx]
+[![made-with-sphinx-doc][label-sphinx-doc]][sphinx]
 
-[https://Git2S3-docs.vigneshrao.com/][runbook]
+[https://thevickypedia.github.io/git2s3/][runbook]
 
 ## License & copyright
 
 &copy; Vignesh Rao
 
 Licensed under the [MIT License][license]
 
-[python]: https://python.org
+[//]: # (Labels)
+
+[label-actions-markdown]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml/badge.svg
+[label-pypi-package]: https://img.shields.io/badge/Pypi%20Package-git2s3-blue?style=for-the-badge&logo=Python
+[label-sphinx-doc]: https://img.shields.io/badge/Made%20with-Sphinx-blue?style=for-the-badge&logo=Sphinx
+[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange
+[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
+[label-actions-pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg
+[label-actions-pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg
+[label-pypi]: https://img.shields.io/pypi/v/git2s3
+[label-pypi-format]: https://img.shields.io/pypi/format/git2s3
+[label-pypi-status]: https://img.shields.io/pypi/status/git2s3
+
 [3.10]: https://docs.python.org/3/whatsnew/3.10.html
 [3.11]: https://docs.python.org/3/whatsnew/3.11.html
 [virtual environment]: https://docs.python.org/3/tutorial/venv.html
-[PyCharm]: https://www.jetbrains.com/pycharm/
-[VSCode]: https://code.visualstudio.com/download
-[repo]: https://api.github.com/repos/thevickypedia/Git2S3
-[license]: https://github.com/thevickypedia/Git2S3/blob/master/LICENSE
-[pypi]: https://pypi.org/project/Git2S3
-[pypi-files]: https://pypi.org/project/Git2S3/#files
-[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
-[wiki]: https://github.com/thevickypedia/Git2S3/wiki
-[release-notes]: https://github.com/thevickypedia/Git2S3/blob/master/release_notes.rst
+[release-notes]: https://github.com/thevickypedia/git2s3/blob/master/release_notes.rst
 [gha_pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml
-[gha_md_valid]: https://github.com/thevickypedia/Git2S3/actions/workflows/markdown.yml
-[gha_cleanup]: https://github.com/thevickypedia/Git2S3/actions/workflows/cleanup.yml
-[webpage]: https://vigneshrao.com/
-[webpage_contact]: https://vigneshrao.com/contact
-[Anaconda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/
-[Miniconda]: https://docs.conda.io/en/latest/miniconda.html#windows-installers
-[vcpp]: https://visualstudio.microsoft.com/visual-cpp-build-tools/
-[git-cli]: https://git-scm.com/download/win/
+[gha_md_valid]: https://github.com/thevickypedia/git2s3/actions/workflows/markdown.yaml
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/
 [sphinx]: https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html
-[runbook]: https://Git2S3-docs.vigneshrao.com/
-
-<!-- labels -->
-
-[label-python]: https://img.shields.io/badge/Made%20with-Python-blue?style=for-the-badge&logo=Python
-[label-pyversion]: https://img.shields.io/badge/python-3.10%20%7C%203.11-orange
-[label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg
-
-[label-language-ct]: https://img.shields.io/github/languages/count/thevickypedia/Git2S3
-[label-code-coverage]: https://img.shields.io/github/languages/top/thevickypedia/Git2S3
-
-[label-license]: https://img.shields.io/github/license/thevickypedia/Git2S3
-
-[label-stars]: https://img.shields.io/github/stars/thevickypedia/Git2S3
-[label-forks]: https://img.shields.io/github/forks/thevickypedia/Git2S3
-[label-watchers]: https://img.shields.io/github/watchers/thevickypedia/Git2S3
-
-[label-repo-size]: https://img.shields.io/github/repo-size/thevickypedia/Git2S3
-[label-code-size]: https://img.shields.io/github/languages/code-size/thevickypedia/Git2S3
-[label-code-line]: http://Git2S3.vigneshrao.com/line-count?badge=true
-[label-file-count]: http://Git2S3.vigneshrao.com/file-count?badge=true
-
-[label-issues-closed]: https://img.shields.io/github/issues-closed-raw/thevickypedia/Git2S3
-[label-issues-raw]: https://img.shields.io/github/issues-raw/thevickypedia/Git2S3
-[label-pr-closed]: https://img.shields.io/github/issues-pr-closed-raw/thevickypedia/Git2S3
-[label-pr-raw]: https://img.shields.io/github/issues-pr-raw/thevickypedia/Git2S3
-
-[label-file-count]: https://tokei.rs/b1/github/thevickypedia/Git2S3?category=files
-[label-line-of-code]: https://tokei.rs/b1/github/thevickypedia/Git2S3?category=code
-
-[label-stats-Modules]: https://img.shields.io/github/search/thevickypedia/Git2S3/module
-[label-stats-Python]: https://img.shields.io/github/search/thevickypedia/Git2S3/.py
-[label-stats-Threads]: https://img.shields.io/github/search/thevickypedia/Git2S3/thread
-[label-stats-Listener]: https://img.shields.io/github/search/thevickypedia/Git2S3/listener
-[label-stats-Speaker]: https://img.shields.io/github/search/thevickypedia/Git2S3/speaker
-[label-stats-Bash]: https://img.shields.io/github/search/thevickypedia/Git2S3/.sh
-[label-stats-AppleScript]: https://img.shields.io/github/search/thevickypedia/Git2S3/.scpt
-[label-stats-Make]: https://img.shields.io/github/search/thevickypedia/Git2S3/Makefile
-
-[label-actions-pages]: https://github.com/thevickypedia/git2s3/actions/workflows/pages/pages-build-deployment/badge.svg
-[label-actions-pypi]: https://github.com/thevickypedia/git2s3/actions/workflows/python-publish.yaml/badge.svg
-
-[label-pypi]: https://img.shields.io/pypi/v/git2s3
-[label-pypi-format]: https://img.shields.io/pypi/format/Git2S3
-[label-pypi-status]: https://img.shields.io/pypi/status/Git2S3
-
-[label-github-repo-created]: https://img.shields.io/date/1599432310
-[label-github-commit-activity]: https://img.shields.io/github/commit-activity/y/thevickypedia/Git2S3
-[label-github-last-commit]: https://img.shields.io/github/last-commit/thevickypedia/Git2S3
-[label-github-last-release]: https://img.shields.io/github/release-date/thevickypedia/Git2S3
-
-[label-active-development]: https://img.shields.io/badge/Development%20Level-Actively%20Developed-success.svg
-[label-actively-maintained]: https://img.shields.io/badge/Maintenance%20Level-Actively%20Maintained-success.svg
-[label-maintainer]: https://img.shields.io/badge/Maintained%20By-Vignesh%20Rao-blue.svg
-
-[label-askme]: https://img.shields.io/badge/SELECT%20*%20FROM-questions-1abc9c.svg
+[pypi]: https://pypi.org/project/git2s3
+[pypi-files]: https://pypi.org/project/git2s3/#files
+[pypi-repo]: https://packaging.python.org/tutorials/packaging-projects/
+[license]: https://github.com/thevickypedia/git2s3/blob/master/LICENSE
+[runbook]: https://thevickypedia.github.io/git2s3/