Release workflow

.github/workflows/release.yml

@@ -20,12 +20,16 @@ jobs:
         uses: astral-sh/setup-uv@v6
         with:
           python-version: 3.12
+          enable-cache: true
+          cache-dependency-glob: "uv.lock"
 
-      - name: Build
-        run: uv-build
+      # should I uv version --bump patch here?
 
-      - name: Publish
-        run: uv-publish --trusted-publishing always
+      - name: Build the project
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --trusted-publishing always
 
   docs:
     runs-on: ubuntu-latest
@@ -54,12 +58,15 @@ jobs:
           git config --local user.email "feedback@materialsproject.org"
           git config --local user.name "materialsproject"
           git stash
-          git pull origin main
+          git pull origin master
           mv CHANGELOG.md docs/
           git add docs/CHANGELOG.md && git commit -m 'Updated CHANGELOG.md'
 
       - name: Push changes
         uses: ad-m/github-push-action@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-# integrate mkdocs at some point
+          branch: master
+
+      - name: Build and Deploy!
+        run: uvx mkdocs gh-deploy

.gitignore

@@ -209,3 +209,7 @@ __marimo__/
 
 # Streamlit
 .streamlit/secrets.toml
+
+json_pages/
+notebooks/
+test_json_pages/

docs/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+
+
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

docs/index.md

@@ -0,0 +1,11 @@
+# Home
+
+For the source code visit the [GitHub Repository](https://github.com/materialsproject/MPCite).
+
+For package instructions visit [PyPi](https://pypi.org/p/mp-cite).
+
+# What is MPCite?
+
+MPCite provides high-throughput, orchestrated functions for the Materials Project to interact programmatically with the DOE Office of Scientific and Technical Information (OSTI) via the E-Link API [[1]](https://github.com/doecode/elinkapi). It enables automated submission, validation, and management of metadata records and Digital Object Identifiers (DOIs) for materials data within the Materials Project ecosystem.
+
+Designed as a backend utility, MPCite ensures robust, scalable DOI assignment workflows through modular and reusable interfaces that integrate directly with MP's data infrastructure.

mkdocs.yml

@@ -0,0 +1,4 @@
+site_name: MPCite
+nav:
+  - Home: index.md
+  - Changelog: CHANGELOG.md

pyproject.toml

@@ -28,6 +28,9 @@ lint = [
     "mypy>=1.17.1",
     "ruff>=0.12.7",
 ]
+docs = [
+    "mkdocs>=1.6.1",
+]
 
 [build-system]
 requires = ["hatchling"]