utopia-project 0.34.1 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6d7813076feeeb716ee8b2fed2db46d2d5522d63ef443632687aec95be009f9
-  data.tar.gz: a77ff26f76a698e3d9c90b86270a4ee9fefeecd6108e9bade9c5d603ffe38081
+  metadata.gz: ce836aa13bef0faf0023d66ba3c5fcb0dca6447e872df581110221fe38ba5991
+  data.tar.gz: 191dba3b66205f9bf29b4095d53681a70c1a9db1d00698ebacc0a38878306295
 SHA512:
-  metadata.gz: 33e47b9495910bd0e04b7b3f35f05f06de0e02c827dcb2c08cc8619b81b70e9986b288f4014a3c5fa544b38c97a21e3373287f49881ad67cedd868353b4e91cf
-  data.tar.gz: aad59c90eb1f6556f6332f42afab40bc81031f2414df7fe83231a9bdb71fe2de7f6a4491aec52b53ab225049732c3d7cd0f92722ae4813331bebc29385c2be3c
+  metadata.gz: 89c0377b952cd09fafb222248c25bb4d4e16a3a068ce40099c0106bd3ef623321fc5bbedb24e226e24d3ed2aaad13137f4d5d69093ea5520906b93cbd320e43a
+  data.tar.gz: fa29db6a3865b528aeef22bd187db14c9cd737efcd6f8fc202d47857e4b4d3454e19794937e40c1d4ec410010007e3bb2fe9a72c89eafe0da602fe382d63c144

data/context/getting-started.md

@@ -1,15 +1,17 @@
 # Getting Started
 
-This guide explains how to use `utopia-project` for your own project.
+This guide explains how to use `utopia-project` to add documentation to your project.
 
 ## Installation
 
-Firstly, add the gem to your project:
+Add the gem to your project:
 
 ~~~ bash
 $ bundle add utopia-project
 ~~~
 
+## Usage
+
 ## Start Local Server
 
 Start the local server to preview documentation:

data/context/github-pages-integration.md

@@ -1,17 +1,67 @@
 # GitHub Pages Integration
 
-This guide shows you how to use `utopia-project` with GitHub Pages.
+This guide shows you how to use `utopia-project` with GitHub Pages to deploy documentation.
 
-## Static Site Generation
+## Enable GitHub Pages
 
-Once you are happy with your project's documentation, use this command to generate a static site:
+In your GitHub project settings, you will need to [enable GitHub Pages from a custom GitHub Actions workflow](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow). Then, use the workflow below to publish the documentation:
 
-~~~ bash
-$ bake utopia:project:static
-~~~
+```yaml
+name: Documentation
 
-This will generate a static copy of your documentation into `docs/` which is what is required by GitHub Pages.
+on:
+  push:
+    branches:
+      - main
 
-## Enable GitHub Pages
+# 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
+
+env:
+  BUNDLE_WITH: maintenance
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
 
-In your GitHub project settings, you will need to [enable GitHub Pages served from `docs/`](https://help.github.com/en/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#choosing-a-publishing-source).
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ruby
+        bundler-cache: true
+    
+    - name: Installing packages
+      run: sudo apt-get install wget
+    
+    - name: Generate documentation
+      timeout-minutes: 5
+      run: bundle exec bake utopia:project:static --force no
+    
+    - name: Upload documentation artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: docs
+  
+  deploy:
+    runs-on: ubuntu-latest
+    
+    environment:
+      name: github-pages
+      url: ${{steps.deployment.outputs.page_url}}
+    
+    needs: generate
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+```

data/context/index.yaml

@@ -9,11 +9,13 @@ metadata:
 files:
 - path: getting-started.md
   title: Getting Started
-  description: This guide explains how to use `utopia-project` for your own project.
-- path: documentation-formatting.md
-  title: Documentation Formatting
-  description: This guide explains the conventions used by `utopia-project` when generating
-    documentation for your project.
+  description: This guide explains how to use `utopia-project` to add documentation
+    to your project.
+- path: documentation-guidelines.md
+  title: Documentation Guides
+  description: This guide explains how to create and maintain documentation for your
+    project using `utopia-project`.
 - path: github-pages-integration.md
   title: GitHub Pages Integration
-  description: This guide shows you how to use `utopia-project` with GitHub Pages.
+  description: This guide shows you how to use `utopia-project` with GitHub Pages
+    to deploy documentation.

data/lib/utopia/project/version.rb

@@ -5,6 +5,6 @@
 
 module Utopia
 	module Project
-		VERSION = "0.34.1"
+		VERSION = "0.35.0"
 	end
 end

data/readme.md

@@ -21,11 +21,11 @@ needs of my users.
 
 Please see the [project documentation](https://socketry.github.io/utopia-project/) for more details.
 
-  - [Getting Started](https://socketry.github.io/utopia-project/guides/getting-started/index) - This guide explains how to use `utopia-project` for your own project.
+  - [Getting Started](https://socketry.github.io/utopia-project/guides/getting-started/index) - This guide explains how to use `utopia-project` to add documentation to your project.
 
-  - [Documentation Formatting](https://socketry.github.io/utopia-project/guides/documentation-formatting/index) - This guide explains the conventions used by `utopia-project` when generating documentation for your project.
+  - [Documentation Guides](https://socketry.github.io/utopia-project/guides/documentation-guidelines/index) - This guide explains how to create and maintain documentation for your project using `utopia-project`.
 
-  - [GitHub Pages Integration](https://socketry.github.io/utopia-project/guides/github-pages-integration/index) - This guide shows you how to use `utopia-project` with GitHub Pages.
+  - [GitHub Pages Integration](https://socketry.github.io/utopia-project/guides/github-pages-integration/index) - This guide shows you how to use `utopia-project` with GitHub Pages to deploy documentation.
 
 ## Releases
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: utopia-project
 version: !ruby/object:Gem::Version
-  version: 0.34.1
+  version: 0.35.0
 platform: ruby
 authors:
 - Samuel Williams