Updating documentation, READMEs, and links (#36)

Getting rid of a lot of docusaurus boilerplate stuff. Some new content. Some re-arranging.

Co-authored-by: Michael Vogelsong <[email protected]>

Author: robotrapta

.github/workflows/docs.yaml renamed to .github/workflows/publish-docs.yaml

@@ -1,21 +1,18 @@
-name: docs
+name: publish-docs
 on:
   push:
     paths:
       # Only run this workflow if there are changes in any of these files.
       - .github/workflows/**
       - docs/**
-  pull_request:
-    paths:
-      # Only run this workflow if there are changes in any of these files.
-      - .github/workflows/**
-      - docs/**
+    branches:
+      - main
 defaults:
   run:
     working-directory: docs
 
 jobs:
-  deploy:
+  deploy-docs:
     runs-on: ubuntu-latest
     steps:
       - name: Get code
@@ -32,12 +29,13 @@ jobs:
       - name: Deploy website
         # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
         uses: peaceiris/actions-gh-pages@v3
-        # Only run this on pushes to the `main` branch (try-docusaurus-base is temporary for testing)
-        if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/try-docusaurus-base'
+        # Only run this on pushes to the `docs`
+        if: github.ref == 'refs/heads/docs'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          # Build output to publish to the `gh-pages` branch:
           publish_dir: ./docs/build
+          #TODO: setup a staging directory when doing a PR
+          #destination_dir: staging
           # The following lines assign commit authorship to the official
           # GH-Actions bot for deploys to `gh-pages` branch:
           # https://github.com/actions/checkout/issues/13#issuecomment-724415212

.github/workflows/publish.yaml renamed to .github/workflows/publish-pypi.yaml

@@ -1,6 +1,10 @@
 # Run integration tests against the integ API endpoint
 name: test integ
-on: [push]
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 jobs:
   run-tests:
     runs-on: ubuntu-20.04
@@ -16,14 +20,14 @@ jobs:
       matrix:
         python-version: [
             #"3.6",   # Default on Ubuntu18.04 but openapi-generator fails
-            "3.7", 
-            "3.8", 
-            "3.9", 
-            "3.10", 
+            "3.7",
+            "3.8",
+            "3.9",
+            "3.10",
             "3.11",
-        ]
-        install_numpy: [ true, false ]
-        install_pillow: [ true, false ]
+          ]
+        install_numpy: [true, false]
+        install_pillow: [true, false]
     env:
       # This is associated with the "sdk-integ-test" user, credentials on 1password
       GROUNDLIGHT_API_TOKEN: ${{ secrets.GROUNDLIGHT_API_TOKEN }}

.github/workflows/test-integ.yaml

@@ -166,3 +166,5 @@ node_modules/
 
 *.swp
 **/.python-version
+
+.DS_Store

.gitignore

@@ -1,8 +1,8 @@
 # Groundlight Python SDK
 
-Check out our [documentation here](https://groundlight.github.io/python-sdk/docs/getting-started)!
+Groundlight makes it simple to build reliable visual applications.  Read the [full documentation here](https://code.groundlight.ai/python-sdk/).
 
-## Computer vision made simple
+## Computer Vision powered by Natural Language
 
 ```bash
 pip install groundlight
@@ -24,3 +24,13 @@ print(f"The answer is {image_query.result}")
 Your images are first analyzed by machine learning (ML) models which are automatically trained on your data. If those models have high enough confidence, that's your answer. But if the models are unsure, then the images are progressively escalated to more resource-intensive analysis methods up to real-time human review. So what you get is a computer vision system that starts working right away without even needing to first gather and label a dataset. At first it will operate with high latency, because people need to review the image queries. But over time, the ML systems will learn and improve so queries come back faster with higher confidence.
 
 _Note: The SDK is currently in "beta" phase. Interfaces are subject to change in future versions._
+
+## Learn more
+
+Some more resources you might like:
+
+* [Code Documentation](https://code.groundlight.ai/)
+* [Python SDK](https://pypi.org/project/groundlight/)
+* [Company](https://www.groundlight.ai/)
+* [Login to Groundlight](https://app.groundlight.ai/)
+

README.md

@@ -3,6 +3,6 @@
   "position": 2,
   "link": {
     "type": "generated-index",
-    "description": "Let's build some apps!"
+    "description": "Let's build some reliable vision applications."
   }
 }