Skip to content

Commit

Permalink
MOB-4984: add jekyll ghpage (#5)
Browse files Browse the repository at this point in the history
* compile jekyll files too

* add a custom 404 page

* add gh-pages links to top-level readme
  • Loading branch information
alrikai authored Mar 4, 2024
1 parent 78a6277 commit 7c96db1
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
27 changes: 25 additions & 2 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,35 @@ on:
branches: ['main']

jobs:
build-jekyll:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
with:
lfs: 'true'
- name: Build Jekyll
uses: actions/jekyll-build-pages@v1
- name: Upload Jekyll Artifact
uses: actions/upload-artifact@v3
with:
name: jekyll-site
path: _site

build-docc:
needs: build-jekyll
runs-on: macos-13
timeout-minutes: 5

timeout-minutes: 10
steps:
- uses: actions/checkout@v4
with:
lfs: 'true'
- name: Download Jekyll Artifact
uses: actions/download-artifact@v3
with:
name: jekyll-site
path: _site

- name: Select Xcode
run: sudo xcode-select -s /Applications/Xcode_15.0.1.app

Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

The HOVER Capture iOS SDK provides a user flow for capturing and submitting 3D scans of homes to be processed by HOVER. This involves a camera experience capable of collecting all necessary data, and instructional and permission management flows to improve capture success rates.

* Documentation: [https://hoverinc.github.io/hover-capture-ios](https://hoverinc.github.io/hover-capture-ios)
* [DocC Documentation](https://hoverinc.github.io/hover-capture-ios/documentation/hvcapturesdk)
* [Tutorials](https://hoverinc.github.io/hover-capture-ios/tutorials/tutorials)

## Installation

### Requirements
Expand Down
9 changes: 9 additions & 0 deletions docs/404.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
permalink: /404.html
---

## Requested page not found

* Documentation: [https://hoverinc.github.io/hover-capture-ios](https://hoverinc.github.io/hover-capture-ios)
* DocC Documentation: [https://hoverinc.github.io/hover-capture-ios/documentation/hvcapturesdk](https://hoverinc.github.io/hover-capture-ios/documentation/hvcapturesdk)
* Tutorials: [https://hoverinc.github.io/hover-capture-ios/tutorials/tutorials](https://hoverinc.github.io/hover-capture-ios/tutorials/tutorials)

0 comments on commit 7c96db1

Please sign in to comment.