Cleanup move

.github/workflows/docs.yml

@@ -0,0 +1,68 @@
+name: Deploy documentation
+
+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 one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    name: docs
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install miniconda
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          miniconda-version: "latest"
+          auto-update-conda: true
+          python-version: "3.12"
+
+      - name: Initialize conda environment
+        run: make conda-create
+
+      - name: Setup conda
+        run: make conda-setup
+
+      - name: Install conda dependencies
+        run: make from-conda-lock
+
+      - name: Install docs dependenices
+        run: make install
+
+      - name: Build documentation
+        run: make docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'public/'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -16,3 +16,4 @@ psi.*.clean
 .obsidian/*
 .mypy_cache
 public/
+.pyc

README.md

@@ -1,7 +1,17 @@
-# Python Breadcrumbs
+<h1 align="center">
+<b>Python</b><br>
+Breadcrumbs
+</h1>
 
 TODO:
 
+## What is Breadcrumbs?
+
+Education stands as a pivotal force in socioeconomic mobility.
+Yet, generational barriers outside of an individual's influence hinder a person's access to educational opportunities.
+Breadcrumbs represents [OASCI's](https://www.oasci.org/) initiative to fundamentally transform access to educational materials, embodying the spirit of discovery and the sharing of knowledge fragments that have traditionally been accessible only through the goodwill of others.
+Breadcrumb websites are freely accessible resources, and we encourage contributions, improvements, and adaptations so long as they abide by the terms outlined in the [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/) license.
+
 ## Deploying
 
 We use [bump-my-version](https://github.com/callowayproject/bump-my-version) to release a new version.
@@ -22,12 +32,12 @@ git push --follow-tags
 
 ## License
 
-Code contained in this project is released under the [MIT License](https://spdx.org/licenses/MIT.html) as specified in [`LICENSE_CODE`](https://gitlab.com/oasci/breadcrumbs/python-bc/-/blob/main/LICENSE_CODE.md).
-This license grants you the freedom to use, modify, and distribute it as long as you include the original copyright notice contained in [`LICENSE_CODE`](https://gitlab.com/oasci/breadcrumbs/python-bc/-/blob/main/LICENSE_CODE.md) and the following notice.
+Code contained in this project is released under the [MIT License](https://spdx.org/licenses/MIT.html) as specified in [`LICENSE_CODE`](https://github.com/oasci-bc/python/blob/main/LICENSE_CODE.md).
+This license grants you the freedom to use, modify, and distribute it as long as you include the original copyright notice contained in [`LICENSE_CODE`](https://github.com/oasci-bc/python/blob/main/LICENSE_CODE.md) and the following notice.
 
-> Portions of this code were incorporated and adapted with permission from [Python Breadcrumbs](https://gitlab.com/oasci/python-bc) by OASCI licensed under the [MIT license](https://gitlab.com/oasci/breadcrumbs/python-bc/-/blob/main/LICENSE_CODE.md).
+> Portions of this code were incorporated and adapted with permission from [python Breadcrumbs](https://github.com/oasci/python) by OASCI licensed under the [MIT license](https://github.com/oasci-bc/python/blob/main/LICENSE_CODE.md).
 
-All other data, information, documentation, and associated content provided within this project are released under the [Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/) as specified in [`LICENSE_INFO`](https://gitlab.com/oasci/breadcrumbs/python-bc/-/blob/main/LICENSE_INFO.md).
+All other data, information, documentation, and associated content provided within this project are released under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (CC BY-NC-SA 4.0)](https://creativecommons.org/licenses/by-nc-sa/4.0/) as specified in [`LICENSE_INFO`](https://github.com/oasci-bc/python/blob/main/LICENSE_INFO.md).
 This means you are free to share and adapt the non-code elements, but you must give appropriate credit to the original source and indicate if changes were made.
 
-> Some content was incorporated and adapted with permission [Python Breadcrumbs](https://gitlab.com/oasci/python-bc) by OASCI licensed under the [CC BY-SA 4.0 license](https://gitlab.com/oasci/breadcrumbs/python-bc/-/blob/main/LICENSE_INFO.md)
+> Some content was incorporated and adapted with permission [python Breadcrumbs](https://github.com/oasci/python) by OASCI licensed under the [CC BY-NC-SA 4.0 license](https://creativecommons.org/licenses/by-nc-sa/4.0/)