Merge pull request #68 from geopozo/andrew/docs

Render docs with new readme

Author: ayjayt

.github/workflows/static.yml

@@ -0,0 +1,46 @@
+---
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+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:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: './site/'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -0,0 +1,42 @@
+*github-helper* is an API connector to help engineering managers quickly check the
+status of one or ALL repositories at the same time.
+
+It has a python, CLI, json, and HTML interface.
+
+### Supported Interfaces:
+
+  - local git repo
+  - git tags via github
+  - github releases
+  - pypi
+  - pypi testing
+  - conda
+
+### Version Auditing
+
+It ensures that versions are the same across sources, and that the builds are
+also the same (same platforms supported). It notified you of discrepancies.
+
+It allows you to set template rules for github and audits your rulesets to make
+sure they are in conformance.
+
+In fact, it can provide a tree-diff for any type of configuration file
+(pre-commits, GHA, etc).
+
+It allows you to check its access level (public private archived), as well as
+who has access.
+
+
+### Example Repo HTML Interface
+
+[Example](docs/repos.html)
+
+![Screenshot of Repos HTML Output](docs/images/repos_html_interface.png)
+
+### Example Version Audit
+
+![Screenshot of Multi-Version Output](docs/images/version_audit.png)
+
+### Example Single-Version Inspection (Incomplete)
+
+![Screenshot of Terminal Output](docs/images/single_version_audit.png)

docs/images/repos_html_interface.png

@@ -13,7 +13,7 @@ nav:
       {
         "dest": "README.md",
         "src": "../README.md",
-        "replace": {"src='docs/": "src='"}
+        "replace": {"src='docs/": "src='", "(docs/": "("}
       }
   - Reference: >-
       {

docs/images/single_version_audit.png

@@ -53,11 +53,11 @@ dev = [
   "types-aiofiles>=24.1.0.20250326",
 ]
 
-#docs = [
-#    "mkquixote @ git+ssh://git@github.com/geopozo/mkquixote; python_version >= '3.11'",
-#    "mkdocs>=1.6.1",
-#    "mkdocs-material>=9.5.49",
-#]
+docs = [
+    "mkquixote @ git+ssh://git@github.com/geopozo/mkquixote; python_version >= '3.11'",
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.5.49",
+]
 
 [tool.ruff.lint]
 select = ["ALL"]