Closes #95. Documentation Updates (#97)

* Updated Download link to release version * Fixed typos in documentation
kasem-sm · Apr 23, 2022 · a31c5a2 · a31c5a2
1 parent 81414bf
commit a31c5a2
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -14,7 +14,7 @@ daily-read reminders, explore new authors, and share your articles**_. App built
 
 ## Latest Release
 
-[![Latest Release](https://img.shields.io/badge/Release-v0.22.0.3850-brightgreen)](https://github.com/kasem-sm/SlimeKT/releases)
+[![Slime APK](https://img.shields.io/github/v/release/kasem-sm/slimekt?color=8D0AF2&label=Download&logo=android&style=for-the-badge)](https://github.com/kasem-sm/SlimeKT/releases)
 
 ## Documentation 📚
 
@@ -39,7 +39,7 @@ official [Android documentation](https://developer.android.com/jetpack/guide)
 
 ## Sample, Screenshots and Demo 📱
 
-[![Slime APK](https://img.shields.io/github/v/release/kasem-sm/slimekt?color=8D0AF2&label=Download&logo=android&style=for-the-badge)](https://github.com/kasem-sm/slimekt/releases/app-release.apk)
+[![Slime APK](https://img.shields.io/github/v/release/kasem-sm/slimekt?color=8D0AF2&label=Download&logo=android&style=for-the-badge)](https://github.com/kasem-sm/SlimeKT/releases/download/v0.22.0.3850/app-release.apk)
 
 ![Screenshot Board 1](/docs/screenshots/board_1.png)
 

diff --git a/docs/api/article/post_article.md b/docs/api/article/post_article.md
@@ -7,6 +7,7 @@
 | `Authorization` | Bearer Token <User Token>` |
 
 It creates a new article provided that the user is authenticated. If the user passes a topic name that doesn't exist, the server will automatically create a new topic with that name.
+Currently this is disabled in production to avoid abuse.
 
 Create Request:
 ```

diff --git a/docs/api/subscribption/get_all_explore_topics.md b/docs/api/subscribption/get_all_explore_topics.md
@@ -2,7 +2,7 @@
   GET api/subscriptionService/explore
 ```
 
-Fetches all the **unsubscribed** topics of the current user. If `userId` is null, the request will redirect to the [Get All Topics] (https://kasem-sm.github.io/SlimeKT/api/topics/get_all_topics/) route.
+Fetches all the **unsubscribed** topics of the current user. If `userId` is null, the request will redirect to the [Get All Topics](https://kasem-sm.github.io/SlimeKT/api/topics/get_all_topics/) route.
 
 
 | Parameter | Type     | Description         | Required | Default Value |

diff --git a/docs/guide/app_architecture.md b/docs/guide/app_architecture.md
@@ -26,3 +26,5 @@ The `viewModel` exposes `uiEvent` and `uiState` and some public functions. `uiEv
 </figure>
 
 ### Interactors
+
+# -- Work In Progress --
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,3 +26,5 @@ The `viewModel` exposes `uiEvent` and `uiState` and some public functions. `uiEv
		</figure>

		### Interactors

		# -- Work In Progress --