Apply just-the-docs theme for docs-site

syntaxerror247 · syntaxerror247 · commit bb6e7e896985 · 2025-05-24T10:24:32.000+05:30
diff --git a/.github/workflows/docs-site.yml b/.github/workflows/docs-site.yml
@@ -0,0 +1,63 @@
+name: Deploy docs site
+
+on:
+  push:
+    branches:
+      - "main"
+    paths:
+      - "docs/**"
+
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.3' # Not needed with a .ruby-version file
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+          cache-version: 0 # Increment this number if you need to re-download cached gems
+          working-directory: '${{ github.workspace }}/docs'
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site/
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
diff --git a/docs/Gemfile b/docs/Gemfile
@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem "jekyll", "~> 4.4.1" # installed by `gem jekyll`
+# gem "webrick"        # required when using Ruby >= 3 and Jekyll <= 4.2.2
+
+gem "just-the-docs", "0.10.1" # pinned to the current release
+# gem "just-the-docs"        # always download the latest release
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,15 @@
+title: Godot Firebase Android
+description: Documentation for the GodotFirebaseAndroid plugin
+theme: just-the-docs
+color_scheme: dark
+
+url: https://syntaxerror247.github.io
+
+aux_links:
+  Plugin Repository: https://github.com/syntaxerror247/GodotFirebaseAndroid
+
+# Footer content
+back_to_top: true
+back_to_top_text: "Back to top"
+
+footer_content: 'Copyright &copy; 2025 Anish Mishra. Distributed by an <a href="https://github.com/syntaxerror247/GodotFirebaseAndroid/blob/main/LICENSE">MIT license.</a>'
diff --git a/docs/authentication.md b/docs/authentication.md
@@ -1,3 +1,9 @@
+---
+layout: default
+title: Authentication
+nav_order: 2
+---
+
 # Authentication
 
 The Firebase Authentication module in **GodotFirebaseAndroid** supports anonymous login, email/password login, Google login, and account management. Each method emits signals to indicate success or failure.
@@ -7,7 +13,7 @@ The Firebase Authentication module in **GodotFirebaseAndroid** supports anonymou
 - `auth_success(current_user_data: Dictionary)`
   Emitted when a user successfully signs in. The dictionary contains user information such as UID, email, etc.
 
-- `auth_failure(error_mplugin.emitGodotSignal("realtime_db_value_changed", path, data)essage: String)`
+- `auth_failure(error_message: String)`
   Emitted when an authentication operation fails.
 
 - `sign_out_success(success: bool)`
diff --git a/docs/firestore.md b/docs/firestore.md
@@ -1,22 +1,28 @@
+---
+layout: default
+title: Cloud Firestore
+nav_order: 3
+---
+
 # Cloud Firestore
 
 The Cloud Firestore module in **GodotFirebaseAndroid** supports adding, retrieving, updating, and deleting documents, as well as listening for document changes.
 
 ## Signals
 
--`write_task_completed(result: Dictionary)`
+- `write_task_completed(result: Dictionary)`
   Emitted after adding or setting a document.
 
--`get_task_completed(result: Dictionary)`
+- `get_task_completed(result: Dictionary)`
   Emitted after retrieving a document or a list of documents.
 
--`update_task_completed(result: Dictionary)`
+- `update_task_completed(result: Dictionary)`
   Emitted after updating a document.
 
--`delete_task_completed(result: Dictionary)`
+- `delete_task_completed(result: Dictionary)`
   Emitted after deleting a document.
 
--`document_changed(document_path: String, data: Dictionary)`
+- `document_changed(document_path: String, data: Dictionary)`
   Emitted when a listened document is changed.
 
 **Note**: All signal result dictionaries contain the following keys:
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,9 @@
+---
+layout: default
+title: Firebase Android
+nav_order: 1
+---
+
 # GodotFirebaseAndroid
 
 **GodotFirebaseAndroid** is an Android plugin for the Godot Engine that integrates Firebase services in Godot Android games and apps.
@@ -27,14 +33,6 @@
    - Open **Project > Export**
    - Enable `gradle_build/use_gradle_build` in Android preset.
 
-## Documentation
-
-- [Authentication](authentication.md)
-- [Cloud Firestore](firestore.md)
-- [Realtime Database](realtime_database.md)
-- [Cloud Storage](storage.md)
-- [Cloud Messaging](messaging.md)
-
 ## License
 
 MIT License
diff --git a/docs/realtime_database.md b/docs/realtime_database.md
@@ -1,22 +1,28 @@
+---
+layout: default
+title: Realtime Database
+nav_order: 4
+---
+
 # Realtime Database
 
 The Realtime Database module in **GodotFirebaseAndroid** supports reading, writing, and listening to changes in the Firebase Realtime Database.
 
 ## Signals
 
--`write_task_completed(result: Dictionary)`
+- `write_task_completed(result: Dictionary)`
   Emitted after a write (set) operation completes. The dictionary contains a `success` boolean and optionally a `message`.
 
--`get_task_completed(result: Dictionary)`
+- `get_task_completed(result: Dictionary)`
   Emitted after a get (read) operation completes. Contains either the fetched data or an error.
 
--`update_task_completed(result: Dictionary)`
+- `update_task_completed(result: Dictionary)`
   Emitted after an update operation. Indicates success or failure.
 
--`delete_task_completed(result: Dictionary)`
+- `delete_task_completed(result: Dictionary)`
   Emitted after a delete operation. Indicates success or failure.
 
--`db_value_changed(path: String, data: Dictionary)`
+- `db_value_changed(path: String, data: Dictionary)`
   Emitted when a value at a listened path changes.
 
 **Note**: All signal result dictionaries contain the following keys:
diff --git a/docs/storage.md b/docs/storage.md
@@ -1,19 +1,25 @@
-# Storage
+---
+layout: default
+title: Cloud Storage
+nav_order: 5
+---
+
+# Cloud Storage
 
 The Cloud Storage module in **GodotFirebaseAndroid** provides methods to upload, download, delete, and list files from Firebase Cloud Storage. Each method emits signals to indicate the outcome of the operation.
 
 ## Signals
 
--`upload_task_completed(result: Dictionary)`
+- `upload_task_completed(result: Dictionary)`
   Emitted when a file upload completes. The result contains metadata or error information.
 
--`download_task_completed(result: Dictionary)`
+- `download_task_completed(result: Dictionary)`
   Emitted when a file download completes. The result contains file information or error details.
 
--`delete_task_completed(result: Dictionary)`
+- `delete_task_completed(result: Dictionary)`
   Emitted when a file is deleted. The result indicates success or failure.
 
--`list_task_completed(result: Dictionary)`
+- `list_task_completed(result: Dictionary)`
   Emitted when files are listed in a directory. The result includes a list of files or error information.
 
 ## Methods
