Just for develop

Open-Smartwatch · Aug 30, 2023 · a6b293d · a6b293d
1 parent 2f3a852
commit a6b293d
Show file tree

Hide file tree

Showing 31 changed files with 7 additions and 507 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -2,13 +2,13 @@
 name: Build and deploy documentation
 
 env:
-  OSW_OS_DOCS_BRANCH: master
+  OSW_OS_DOCS_BRANCH: develop
 
 on:
   push:
     branches: ["master"]
   schedule:
-    - cron:  '0 0 * * *' # Automatic daily rebuild, to keep the documentation up-to-date even if maintainers forget to trigger a rebuild manually
+    - cron: "0 0 * * *" # Automatic daily rebuild, to keep the documentation up-to-date even if maintainers forget to trigger a rebuild manually
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -47,7 +47,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v1
         with:
-          path: './public/'
+          path: "./public/"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1
diff --git a/3d-file-render-stage/3d-files-render-stage.blend b/3d-file-render-stage/3d-files-render-stage.blend
diff --git a/README.md b/README.md
@@ -1,19 +1,3 @@
 # Open Smartwatch Documentation
-This repository contains the source code for the Open Smartwatch documentation.
 
-In case you want to compile this documentation yourself, you may use [Python Poetry](https://python-poetry.org/) to install the dependencies and then build the documentation using `mkdocs`:
-
-```bash
-poetry install
-poetry run mkdocs build
-```
-
-## Warning
-
-**As this repository contains binary data (e.g. schematics or images), make sure to have `git-lfs` installed!** Cloning this repository without `git-lfs` will result in missing or broken files.
-
-This documentation depends on the [open-smartwatch-os](https://github.com/Open-Smartwatch/open-smartwatch-os) repository and its `docs` folder. If you want to build this documentation locally (and not receive warnings or have incomplete results), you need to clone the `open-smartwatch-os` repository and merge its `docs` folder into this repositories `docs` folder. Furthermore, you'll need to mount its `docs/config.yml` structure into this repositories `mkdocs.yml` file (under `nav.Firmware`). If you are not sure how to do this, you may use the Python script `embed_osw_os_docs.py` inside the `.github` folder, which is also used by the GitHub Actions workflow.
-
-```bash
-poetry run python .github/embed_osw_os_docs.py
-```
+**This page is just to view the latest documentation of the operating systems `develop` branch. Please switch to [the primary page](https://open-smartwatch.github.io/) for anything else. Thanks!**
diff --git a/docs/assets/3d-files/light-flex-buttons.png b/docs/assets/3d-files/light-flex-buttons.png
diff --git a/docs/assets/3d-files/light-rect.png b/docs/assets/3d-files/light-rect.png
diff --git a/docs/assets/downloads/sla-case-v2.sl1 b/docs/assets/downloads/sla-case-v2.sl1
diff --git a/docs/assets/gallery/light-edition/p3dt-00.jpg b/docs/assets/gallery/light-edition/p3dt-00.jpg
diff --git a/docs/assets/renders/case-v1.0-bot.png b/docs/assets/renders/case-v1.0-bot.png
diff --git a/docs/assets/renders/case-v1.0-top.png b/docs/assets/renders/case-v1.0-top.png
diff --git a/docs/assets/renders/logo.png b/docs/assets/renders/logo.png
diff --git a/docs/assets/screenshots/blender.jpg b/docs/assets/screenshots/blender.jpg
diff --git a/docs/assets/screenshots/case-issue.png b/docs/assets/screenshots/case-issue.png
diff --git a/docs/assets/screenshots/kicad-pcb.jpg b/docs/assets/screenshots/kicad-pcb.jpg
diff --git a/docs/assets/screenshots/kicad-schematics.jpg b/docs/assets/screenshots/kicad-schematics.jpg
diff --git a/docs/assets/screenshots/sla-case-v2.png b/docs/assets/screenshots/sla-case-v2.png
diff --git a/docs/coc.md b/docs/coc.md
diff --git a/docs/gallery/gallery-main.md b/docs/gallery/gallery-main.md
diff --git a/docs/howto/aliexpress.md b/docs/howto/aliexpress.md
diff --git a/docs/howto/assembly.md b/docs/howto/assembly.md
diff --git a/docs/howto/contribute.md b/docs/howto/contribute.md
diff --git a/docs/howto/hardware.md b/docs/howto/hardware.md
diff --git a/docs/howto/software.md b/docs/howto/software.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,36 +1,5 @@
 <img src="assets/logo.png" width="320px"/>
 
 The Open-SmartWatch is an open source project created by [@pauls_3d_things](https://www.instagram.com/pauls_3d_things/)/[p3dt.net](https://p3dt.net).
-It consists of hardware modules, 3D printable cases and a custom operating system to build smartwatches with the goal that they can be assembled, repaired, and modified by everyone. There are currently two versions:
 
-* [Light edition](watches/light-edition.md) (released)
-* [GPS edition](watches/gps-edition.md) (preview, work in progress)
-
-Check out the apps to see what the watch can do!
-
-* [Watchfaces](firmware/apps/watchfaces.md)
-* [Tools](firmware/apps/tools.md)
-* [Games](firmware/apps/games.md)
-
-See the following pages for:
-
-* [Hardware](resources/hardware.md): for ordering PCBs, or assembled watches
-* [Firmware](firmware/osw_os.md): for infos on flashing the latest firmware
-* [3D-Files](resources/3d-files.md): for 3D-printable design files
-* [Open-Smartwatch-OS](https://github.com/Open-Smartwatch/open-smartwatch-os): the source code on GitHub. The main branch should be stable, the develop branch is usually more up to date and can be unstable.
-* [p3dt's discord/open-smartwatch channels](https://discord.gg/9DK5JY6): to join the discussion and learn how to contribute
-
-## Media Coverage
-
-* `@pauls_3d_things` on [Instagram](https://www.instagram.com/pauls_3d_things/) (Latest Updates)
-* `#opensmartwatch` on [Instagram](https://www.instagram.com/explore/tags/opensmartwatch/) (See what the community creates)
-* `pauls_3d_things` on [Youtube](https://www.youtube.com/playlist?list=PL7YtNcHw1zWL9PEBSJg6sBpESSBoHjDY6) (Tutorials + Instructions)
-* Linus Tech Tips: [It's time.](https://www.youtube.com/watch?v=xF_SR6aUKHg)
-* Hackaday: [An Open Source Smart Watch you'd actually wear](https://hackaday.com/2021/04/08/an-open-source-smart-watch-youd-actually-wear/)
-* CNX-Software: [LilyGo sells Open-Smartwatch open-source hardware ESP32 watch by “Paul’s 3D Things”](https://www.cnx-software.com/2021/04/07/lilygo-open-smartwatch-open-source-hardware-esp32-watch-by-pauls-3d-things/)
-* hackster.io: [Something ESPecially Impressive about the Open-Smartwatch Project](https://www.hackster.io/news/there-s-something-especially-impressive-about-the-opensmartwatch-project-c2c878b983cf)
-
-## Sponsors
-
-* [Aisler B. V.](https://aisler.net) provided PCBs to support the hardware development
-* [PCBgogo](https://www.pcbgogo.com) provided PCBs to support the hardware development
+**This page is just to view the latest documentation of the operating systems `develop` branch. Please switch to [the primary page](https://open-smartwatch.github.io/) for anything else. Thanks!**
diff --git a/docs/resources/3d-files-gps-edition.md b/docs/resources/3d-files-gps-edition.md