Skip to content

Commit ca19786

Browse files
committed
feat: Migrate docs
0 parents  commit ca19786

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+2776
-0
lines changed

.github/workflows/deploy-wiki.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy this repository (wiki) to the wiki repository of ChameleonUltra
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
jobs:
9+
deploy-wiki:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout source repository
13+
uses: actions/checkout@v4
14+
with:
15+
path: source-repo
16+
17+
- name: Checkout wiki repository
18+
uses: actions/checkout@v4
19+
with:
20+
repository: RfidResearchGroup/ChameleonUltra.wiki
21+
path: wiki-repo
22+
token: ${{ secrets.WIKI_DEPLOY_TOKEN }}
23+
24+
- name: Copy content to wiki repository
25+
run: |
26+
# Remove everything from wiki except .git directory
27+
find wiki-repo -mindepth 1 -maxdepth 1 -not -name .git -exec rm -rf {} +
28+
29+
# Copy all files from source to wiki
30+
cp -r source-repo/* wiki-repo/
31+
32+
# Debug info
33+
echo "Files to be committed to wiki:"
34+
ls -la wiki-repo
35+
36+
- name: Commit and push to wiki
37+
working-directory: wiki-repo
38+
run: |
39+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
40+
git config --local user.name "github-actions[bot]"
41+
42+
# Add all changes
43+
git add .
44+
45+
# Commit if there are changes
46+
if git diff --staged --quiet; then
47+
echo "No changes to commit"
48+
else
49+
git commit -m "Update wiki content from docs repository"
50+
git push
51+
fi
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Deploy wiki to GitHub Pages with Jekyll
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
workflow_dispatch:
7+
8+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
15+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
# Build job
22+
build:
23+
runs-on: ubuntu-latest
24+
steps:
25+
- name: Checkout
26+
uses: actions/checkout@v4
27+
- name: Setup Pages
28+
uses: actions/configure-pages@v5
29+
- name: Build with Jekyll
30+
uses: actions/jekyll-build-pages@v1
31+
with:
32+
source: ./
33+
destination: ./_site
34+
- name: Upload artifact
35+
uses: actions/upload-pages-artifact@v3
36+
37+
# Deployment job
38+
deploy:
39+
environment:
40+
name: github-pages
41+
url: ${{ steps.deployment.outputs.page_url }}
42+
runs-on: ubuntu-latest
43+
needs: build
44+
steps:
45+
- name: Deploy to GitHub Pages
46+
id: deployment
47+
uses: actions/deploy-pages@v4

Home.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Chameleon Ultra Guide
2+
3+
This guide goal is to guide you through setting up and using your Chameleon Ultra and Lite.
4+
5+
This Guide is split up into multiple "subguides":
6+
7+
### About the device
8+
9+
- [[Whitepaper|technical_whitepaper]]: Discover what the Chameleon Ultra is capable of.
10+
11+
- [[Hardware|hardware]]: Learn to know the hardware of your Chameleon.
12+
13+
- [[Firmware|firmware]]: Your Chameleon runs a firmware, learn what it can do and how to use it.
14+
15+
### Interacting with the device
16+
17+
- [[Quickstart|quickstart]]: For the impatient people to just get you up and running with anything.
18+
19+
- [[CLI|cli]]: The official way to control your Chameleon is via the **C**ommand **L**ine **I**nterface (CLI). Learn how to install and master the CLI.
20+
21+
- [[GUIs|gui]]: Some people also develop **G**raphical **U**ser **I**nterfaces (GUIs), these may be a good start for people that do not want to deal with a CLI.
22+
23+
- [[Troubleshooting|troubleshooting]]: For when things go wrong, here are some common tips to maybe fix whatever issue you might have.
24+
25+
### For developers
26+
27+
- [[Development|development]]: For all developers. This covers how to build firmware from source and set up a development environment.
28+
29+
- [[SDKs|sdk]]: SDKs for Chameleon, useful if you want to develop your own application to control Chameleon.
30+
31+
- [[Protocol|protocol]]: The gory details of the communication protocol, useful if you want to develop your own client.
32+
33+
### Miscellaneous
34+
35+
- [[Modding|modding]]: Third party moddings worth mentioning.
36+
37+
- [[FAQ|faq]]: **F**requently **A**sked **Q**uestions, if you have a question, it might already be answered here.

0 commit comments

Comments
 (0)