#25 Updated mkdocs nav for SIM card docs

vestrel00 · Mar 25, 2022 · 6a153b2 · 6a153b2
1 parent 9ee8143
commit 6a153b2
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 6 deletions.
diff --git a/docs/sim/about-sim-contacts.md b/docs/sim/about-sim-contacts.md
@@ -72,14 +72,14 @@ Projections, selections, and order is not supported by the `IccProvider`. Theref
 to provide `include`, `where`, `orderBy`, `limit`, and `offset` functions in our `SimContactsQuery`
 API.
 
-Due to all of these limitations, all queries will return all contacts in the SIM card.
+Due to all of these limitations, all queries will return all contacts in the SIM card. Consumers of
+this library can perform their own sorting and pagination if they wish.
 
 Depending on memory size,
 [SIM cards can hold 200 to 500+ contacts](https://www.quora.com/How-many-contacts-can-I-save-on-my-SIM-card).
 The most common being around 250. Most, if not all, SIM cards have less than 1mb memory (averaging
 32KB to 64KB). Therefore, memory and speed should not be affected much by not being able to
-sort/order and paginate. Consumers of this library can perform their own sorting and pagination if
-they wish.
+sort/order and paginate at the query level. 
 
 ## Debugging
 

diff --git a/docs/sim/delete-sim-contacts.md b/docs/sim/delete-sim-contacts.md
@@ -1,4 +1,4 @@
-# Insert contacts from SIM card
+# Delete contacts from SIM card
 
 This library provides the `SimContactsDelete` API that allows you to delete existing contacts from
 the SIM card.

diff --git a/docs/sim/query-sim-contacts.md b/docs/sim/query-sim-contacts.md
@@ -23,7 +23,14 @@ Projections, selections, and order is not supported by the `IccProvider`. Theref
 to provide `include`, `where`, `orderBy`, `limit`, and `offset` functions in our `SimContactsQuery`
 API.
 
-Due to all of these limitations, all queries will return all contacts in the SIM card.
+Due to all of these limitations, all queries will return all contacts in the SIM card. You may 
+perform your own sorting and pagination if you wish.
+
+> Depending on memory size,
+> [SIM cards can hold 200 to 500+ contacts](https://www.quora.com/How-many-contacts-can-I-save-on-my-SIM-card).
+> The most common being around 250. Most, if not all, SIM cards have less than 1mb memory (averaging
+> 32KB to 64KB). Therefore, memory and speed should not be affected much by not being able to
+> sort/order and paginate at the query level. 
 
 For more info, read about [SIM Contacts](./about-sim-contacts.md)
 

diff --git a/docs/sim/update-sim-contacts.md b/docs/sim/update-sim-contacts.md
@@ -1,4 +1,4 @@
-# Updates contacts in SIM card
+# Update contacts in SIM card
 
 This library provides the `SimContactsUpdate` API that allows you to update contacts in the SIM card.
 

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -61,6 +61,12 @@ nav:
     - 'Query for Accounts': accounts/query-accounts.md
     - 'Query RawContacts': accounts/query-raw-contacts.md
     - 'Associate a local RawContact to an Account': accounts/associate-device-local-raw-contacts-to-an-account.md
+  - 'SIM card':
+      - 'About SIM contacts': sim/about-sim-contacts.md
+      - 'Query contacts in SIM card': sim/query-sim-contacts.md
+      - 'Insert contacts into SIM card': sim/insert-sim-contacts.md
+      - 'Update contacts in SIM card': sim/update-sim-contacts.md
+      - 'Delete contacts from SIM card': sim/delete-sim-contacts.md
   - 'Blocked numbers':
     - 'About blocked numbers': blockednumbers/about-blocked-numbers.md
     - 'Query blocked numbers': blockednumbers/query-blocked-numbers.md
@@ -85,6 +91,7 @@ nav:
   - 'Debug':
       - 'Debug the Contacts Provider tables': debug/debug-contacts-provider-tables.md
       - 'Debug the BlockedNumber Provider tables': debug/debug-blockednumber-provider-tables.md
+      - 'Debug the Sim Contacts table': debug/debug-sim-contacts-tables.md
   - 'Contributing': contributing.md
   - 'Developer notes': dev-notes.md