feat: Add documentation generation and publishing

Author: filiphsps

.github/img/favicon.png

@@ -0,0 +1,28 @@
+name: docs
+on:
+    push:
+        branches:
+            - master
+
+jobs:
+    docs:
+        name: 📖 Docs
+        runs-on: ubuntu-latest
+        steps:
+            - name: 🕶️ Checkout repository
+              uses: actions/checkout@v4
+
+            - name: 🚀 Bootstrap
+              uses: ./.github/common/bootstrap
+
+            - name: 🔨 Build docs
+              run: pnpm run docs
+
+            - uses: peaceiris/actions-gh-pages@v4
+              if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  publish_dir: ./docs
+                  enable_jekyll: false
+                  commit_message: ${{ github.event.head_commit.message }}
+                  force_orphan: true

.github/workflows/docs.yml

@@ -36,6 +36,7 @@ coverage-temp/
 .turbo
 android
 ios
+/docs/
 
 notes.txt
 project.inlang

.gitignore

@@ -30,7 +30,7 @@ This guide helps you submit effective bug reports for our projects. Clear, detai
 Before creating a new report, please review [this list](#before-submitting-a-bug-report) to avoid duplicate submissions. When reporting bugs, [include comprehensive details](#how-do-i-submit-a-good-bug-report) and use [our template](https://github.com/filiphsps/AdaptiveShell/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) to ensure all necessary information is provided.
 
 > [!NOTE]
-> If you find a **Closed** issue similar to your problem, create a new issue and reference the original one in your description.
+> If you find a **closed** issue similar to your current problem, please create a new issue and reference the original one in your description as that will help us find the regression way faster.
 
 ### How Do I Submit A (Good) Bug Report?
 

CONTRIBUTING.md

@@ -0,0 +1 @@
+# AdaptiveShell

apps/launcher/README.md

@@ -0,0 +1,8 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "name": "Launcher",
+    "entryPoints": ["./index.ts"],
+    "readme": "./README.md",
+    "basePath": "./src",
+    "projectDocuments": ["./docs/**/*.md"]
+}

apps/launcher/typedoc.json

@@ -25,7 +25,8 @@
         "release": "changeset publish",
         "release:unstable": "changeset publish --snapshot --no-git-tag --tag unstable",
         "changeset": "changeset",
-        "changeset:conventional": "changeset-conventional"
+        "changeset:conventional": "changeset-conventional",
+        "docs": "typedoc"
     },
     "contributors": [
         {
@@ -63,6 +64,14 @@
         "nyc": "17.1.0",
         "turbo-ignore": "2.5.5",
         "turbo": "2.5.5",
+        "typedoc-material-theme": "1.4.0",
+        "typedoc-plugin-dt-links": "2.0.12",
+        "typedoc-plugin-extras": "4.0.1",
+        "typedoc-plugin-inline-sources": "1.3.0",
+        "typedoc-plugin-merge-modules": "7.0.0",
+        "typedoc-plugin-missing-exports": "4.0.0",
+        "typedoc-plugin-rename-defaults": "0.7.3",
+        "typedoc": "0.28.9",
         "typescript": "5.9.2"
     },
     "pnpm": {

package.json

@@ -0,0 +1,3 @@
+# @metro-ui/live-tiles
+
+[![npm](https://img.shields.io/npm/dt/@metro-ui/live-tiles)](https://www.npmjs.com/package/@metro-ui/live-tiles)

packages/live-tiles/README.md

@@ -0,0 +1,8 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "name": "LiveTiles",
+    "entryPoints": ["src/index.ts"],
+    "readme": "./README.md",
+    "basePath": "./src",
+    "projectDocuments": ["./docs/**/*.md"]
+}