Update docs

MrAsterisco · Apr 11, 2024 · 1fd1ade · 1fd1ade
1 parent c2c989b
commit 1fd1ade
Show file tree

Hide file tree

Showing 362 changed files with 661 additions and 652 deletions.
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,12 +1,14 @@
-#  Release
+# Release
+
 To release a new version of RxFireAuth, follow these steps:
 
 ## Prerequisites
+
 - RxFireAuth follows [git-flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). You should initiate a release only from a `hotfix/*` or `release/*` branch.
-- If you made any changes to the documentation, you'll need [Jazzy](https://github.com/realm/jazzy).
 - Make sure that all targets in the `RxFireAuth` project under `Example-SwiftPM` build and run correctly.
 
 ## Steps
+
 - If you made any change that affects the documentation, run the following command in a Terminal in the RxFireAuth root folder:
 
 ```bash
@@ -15,8 +17,8 @@ swift package --allow-writing-to-directory docs generate-documentation --target
 
 - Commit all your changes, push them and finish the `hotfix` or `release` branch using a git-flow compatible client. Some clients let you tag a release/hotfix immediately: make sure to follow the naming convention when creating your tag (i.e. `v1.5.0`).
 - Push all branches (you may have commits to push on either `develop` and `master` or both).
-- If you haven't tagged the release already, use your favorite git client (GitHub can do this as well) to add a tag *(not a GitHub release - see above for the tags naming convention)*.
+- If you haven't tagged the release already, use your favorite git client (GitHub can do this as well) to add a tag _(not a GitHub release - see above for the tags naming convention)_.
 - Go back to GitHub and [create a new release](https://github.com/MrAsterisco/RxFireAuth/releases/new).
 - Insert the tag name and the version name (which is exactly the version number, without the initial "v").
-- Detail the changes using three categories: "Added", "Improved" and "Fixed". *When referencing bugs, make sure to include a link to the GitHub issue*.
+- Detail the changes using three categories: "Added", "Improved" and "Fixed". _When referencing bugs, make sure to include a link to the GitHub issue_.
 - Once ready, publish the release.
diff --git a/docs/css/523.e9a069b0.css b/docs/css/523.e9a069b0.css
diff --git a/docs/css/675.40c3bcb2.css b/docs/css/675.40c3bcb2.css
diff --git a/docs/css/chunk-c0335d80.10a2f091.css b/docs/css/chunk-c0335d80.10a2f091.css
diff --git a/docs/css/documentation-topic.1d1eec04.css b/docs/css/documentation-topic.1d1eec04.css
diff --git a/docs/css/documentation-topic.b186e79f.css b/docs/css/documentation-topic.b186e79f.css
diff --git a/docs/css/documentation-topic~topic.b6287bcf.css b/docs/css/documentation-topic~topic.b6287bcf.css
diff --git a/docs/css/documentation-topic~topic~tutorials-overview.d6f5411c.css b/docs/css/documentation-topic~topic~tutorials-overview.d6f5411c.css
diff --git a/docs/css/index.038e887c.css b/docs/css/index.038e887c.css
diff --git a/docs/css/index.ff036a9e.css b/docs/css/index.ff036a9e.css
diff --git a/docs/css/topic.672a9049.css b/docs/css/topic.672a9049.css
diff --git a/docs/css/topic.d8c126f3.css b/docs/css/topic.d8c126f3.css
diff --git a/docs/css/tutorials-overview.6eb589ed.css b/docs/css/tutorials-overview.6eb589ed.css
diff --git a/docs/css/tutorials-overview.c249c765.css b/docs/css/tutorials-overview.c249c765.css