Merge pull request #12 from project-ocre/cleanup

Changed out init url for https, added next steps after flashing ocre-…

Author: gonzolively

.github/workflows/publish.yml

@@ -1,25 +1,16 @@
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-# Build and Deploy Ocre Docs to GitHub Pages
 name: Publish 
-
 on:
   push:
     branches: ["main"]
-
-  # Allows you to run this workflow manually from the Actions tab
+  pull_request:
+    branches: ["main"]
   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
@@ -34,23 +25,22 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.3' # Not needed with a .ruby-version file
-          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-          cache-version: 0 # Increment this number if you need to re-download cached gems
+          ruby-version: '3.4'
+          bundler-cache: true
+          cache-version: 0
       - name: Setup Pages
         id: pages
         uses: actions/configure-pages@v5
       - name: Build with Jekyll
-        # Outputs to the './_site' directory by default
         run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
         env:
           JEKYLL_ENV: production
       - name: Upload artifact
-        # Automatically uploads an artifact from the './_site' directory by default
         uses: actions/upload-pages-artifact@v3
 
-  # Deployment job
+  # Deployment job - only runs on push to main
   deploy:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
@@ -59,4 +49,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v4

Gemfile

@@ -1,7 +1,8 @@
 source 'https://rubygems.org'
-
 gem "jekyll", "~> 4.3.4" # installed by `gem jekyll`
 # gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
-
 gem "just-the-docs", "0.10.1" # pinned to the current release
 # gem "just-the-docs"        # always download the latest release
+gem "csv"
+gem "base64"
+gem "logger"

Gemfile.lock

@@ -3,20 +3,19 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
+    base64 (0.2.0)
     bigdecimal (3.1.9)
     colorator (1.1.0)
     concurrent-ruby (1.3.4)
+    csv (3.3.2)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
     ffi (1.17.1-arm64-darwin)
     ffi (1.17.1-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
-    google-protobuf (4.29.2-arm64-darwin)
-      bigdecimal
-      rake (>= 13)
-    google-protobuf (4.29.2-x86_64-linux)
+    google-protobuf (4.29.2)
       bigdecimal
       rake (>= 13)
     http_parser.rb (0.8.0)
@@ -59,6 +58,7 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.4)
     mercenary (0.4.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
@@ -84,8 +84,11 @@ PLATFORMS
   x86_64-linux-gnu
 
 DEPENDENCIES
+  base64
+  csv
   jekyll (~> 4.3.4)
   just-the-docs (= 0.10.1)
+  logger
 
 BUNDLED WITH
    2.5.9

docs/quickstart/firmware/hardware.md

@@ -47,7 +47,7 @@ pip install west
 
 Now, initialize the `ocre-runtime` repo.
 ```
-west init -m git@github.com:project-ocre/ocre-runtime.git
+west init -m https://github.com/project-ocre/ocre-runtime.git 
 ```
 
 Lastly, update the repo with the `west` utility.
@@ -57,7 +57,7 @@ west update
 ```
 
 {: .note}
-`west update` may take 5-10 minutes as it pulls all Zephyr Project board sources.
+This step may take 5-10 minutes as it pulls all Zephyr Project board sources.
 
 ### **5. Install Additional Zephyr (pip) requirements**
 
@@ -75,7 +75,7 @@ west build -b BOARD_NAME ./application -d build -- -DMODULE_EXT_ROOT=`pwd`/appli
 ```
 
 {: .note}
-You can also run the **West Build** task directly from the **Ocre Workspace** file as defined in the [Ocre Workspace File](../../../reference/workspacefile) reference. If you do, be sure to select your board as your build target from the dropdown list of available boards. 
+Your board's name can be found in the Zephyr [Supported Boards](https://docs.zephyrproject.org/3.7.0/boards/index.html) guide.
 
 ### **7. Flash the Ocre Runtime to Your Device**
 
@@ -95,4 +95,10 @@ To flash the Ocre Runtime to your device follow these steps:
 ## Troubleshooting
 This section covers common issues you might encounter when building and flashing the Ocre runtime to physical hardware, along with their solutions.
 
-- **Unsupported Board**: If you're unable to flash to your board, and it's not listed in our [Board Support](../../../board-support), check out our [Adding Board Support](../../../board-support/adding-support) guide under the Board Support section. This guide will walk you through the process of adding support for your specific hardware. 
+- **Unsupported Board**: If you're unable to flash to your board, and it's not listed in our [Board Support](../../../board-support), check out our [Adding Board Support](../../../board-support/adding-support) guide under the Board Support section. This guide will walk you through the process of adding support for your specific hardware. 
+
+---
+
+## Next Steps
+
+Now that you have successfully built and flashed the Ocre runtime to your device, you're ready to create your first Ocre application. Head over to [Your First Container](../../first-app) to get started building containerized applications.

docs/quickstart/firmware/simulated.md

@@ -55,7 +55,7 @@ pip install west
 
 Now, initialize the `ocre-runtime` repo.
 ```
-west init -m git@github.com:project-ocre/ocre-runtime.git
+west init -m https://github.com/project-ocre/ocre-runtime.git 
 ```
 
 Lastly, update the repo with the `west` utility.
@@ -65,7 +65,7 @@ west update
 ```
 
 {: .note}
-`west update` may take 5-10 minutes as it pulls all Zephyr Project board sources.
+This step may take 5-10 minutes as it pulls all Zephyr Project board sources.
 
 ### **5. Install Additional Zephyr (pip) requirements**
 
@@ -94,4 +94,10 @@ To run the application, simply run the following command:
 
 If successful, you should see the following output:
 
-![](../success.png)
+![](../success.png)
+
+---
+
+## Next Steps
+
+Now that you have successfully built and flashed the Ocre runtime to your device, you're ready to create your first Ocre application. Head over to [Your First Container](../../first-app) to get started building containerized applications.

docs/quickstart/first-app/index.md

@@ -7,15 +7,15 @@ has_children: true
 has_toc: false
 ---
 
-# Your First App
+# Your First Container 
 
 This section guides you through creating your first containerized application with Ocre. You'll set up a development environment and build a simple application that demonstrates Ocre's core capabilities.
 
 ---
 
 ## Getting Started
 
-Begin by following our [Setting Up Your Development Environment](./dev-environment) guide to install and configure the necessary tools. This guide offers two approaches:
+Begin by following our [Setting Up Your Development Environment](./dev-environment) guide to install and configure the necessary tools. This guide offers *two* approaches:
 - Using Visual Studio Code with Dev Containers for an integrated IDE experience
 - Using Docker interactively for a command-line workflow