Skip to content

Commit 0a377e4

Browse files
committed
Docs Review
Minor updates from docs review. Adding GH pages build file.
1 parent 9123bdb commit 0a377e4

6 files changed

Lines changed: 339 additions & 281 deletions

File tree

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
# Review gh actions docs if you want to further define triggers, paths, etc
10+
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
11+
12+
jobs:
13+
build:
14+
name: Build Docusaurus
15+
runs-on: ubuntu-latest
16+
defaults:
17+
run:
18+
working-directory: ./docs
19+
steps:
20+
- uses: actions/checkout@v6
21+
with:
22+
fetch-depth: 0
23+
- uses: actions/setup-node@v6
24+
with:
25+
node-version: lts/*
26+
cache: npm
27+
cache-dependency-path: ./docs/package-lock.json
28+
29+
- name: Install dependencies
30+
run: npm ci
31+
32+
- name: Build website
33+
env:
34+
ALGOLIA_APP_KEY: ${{ secrets.DOCS_ALGOLIA_APP_KEY }}
35+
ALGOLIA_APPID: ${{ secrets.DOCS_ALGOLIA_APPID }}
36+
ALGOLIA_INDEX_NAME: ${{ secrets.DOCS_ALGOLIA_INDEX_NAME }}
37+
run: npm run build
38+
39+
- name: Upload Build Artifact
40+
uses: actions/upload-pages-artifact@v4
41+
with:
42+
path: ./docs/build
43+
44+
deploy:
45+
name: Deploy to GitHub Pages
46+
needs: build
47+
48+
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
49+
permissions:
50+
pages: write # to deploy to Pages
51+
id-token: write # to verify the deployment originates from an appropriate source
52+
53+
# Deploy to the github-pages environment
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
58+
runs-on: ubuntu-latest
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

docs/docs/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ slug: /
55
# Introduction
66

77
<figure>
8-
![Thing Plus - ESP32-C5 Banner Image](/docs/img/)
8+
![Thing Plus - ESP32-C5 Banner Image](/img/Thing_Plus-ESP32-C5_HGBanner.png)
99
</figure>
1010

1111
Delivering some of the best wireless capability on the market in a familiar footprint, the SparkFun Thing Plus - ESP32-C5 Thing is built to handle complex Internet of Things (IoT) projects with ease. Powered by the ESP32-C5-WROOM-1 module from Espressif™, this board features a 32-bit RISC-V single-core microprocessor paired with a generous 8MB of Flash memory and 8MB of PSRAM. The ESP32-C5 is a wireless module that supports dual-band WiFi (2.4 and 5GHz) along with Bluetooth<sup>&reg;</sup> 5, Zigbee and Thread.
File renamed without changes.
Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
1-
## General Troubleshooting
2-
3-
!!! warning "Need Help?"
4-
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistance) page for some initial troubleshooting.
5-
6-
<center>
7-
[SparkFun Technical Assistance Page](https://www.sparkfun.com/technical_assistance){ .md-button .md-button--primary }
8-
</center>
9-
10-
If you can't find what you need there, the [SparkFun Forums](https://forum.sparkfun.com/index.php) is a great place to search product forums and ask questions.
11-
12-
!!! info "Account Registration Required"
13-
If this is your first visit to our forum, you'll need to create a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to post questions.
1+
# Troubleshooting
2+
3+
## Support
4+
5+
If you need technical assistance or more information on a product that is not working as you expected, we recommend heading on over to the [SparkFun Technical Assistance](https://www.sparkfun.com/technical_assistance) page for some initial troubleshooting.
6+
7+
If you need technical assistance and more information on a product that is not working as you expected, visit the [SparkFun Community](https://community.sparkfun.com). The community forums are monitored by the SparkFun Technical Support Team and the SparkFun community as a whole. If this is your first visit to our forum, you'll need to create a [Forum Account](https://forum.sparkfun.com/ucp.php?mode=register) to post questions.
8+
9+

0 commit comments

Comments
 (0)