update docs

docs/features.rst

@@ -22,7 +22,7 @@ Special Keywords
 There is a small set of reserved keywords, some by Twilio and some by apostello.
 
 * Twilio's reserved keywords can be found `here <https://www.twilio.com/help/faq/sms/does-twilio-support-stop-block-and-cancel-aka-sms-filtering>`_.
-* apostello also reserves the keyword **name**. Any SMS that matches **name** will be parsed for a name and used to update the name associated with that contact in the DB. If the parsing fails, then the contact is sent another message asking them to try again.
+* apostello also reserves the keyword **name**. Any SMS that matches **name** will be parsed for a name and used to update the name associated with that contact. If the parsing fails, then the contact is sent another message asking them to try again.
 
 Custom Keywords
 ~~~~~~~~~~~~~~~
@@ -43,9 +43,11 @@ You can create as many keywords as you like, and each keyword comes with the fol
 Keyword Matching
 ~~~~~~~~~~~~~~~~
 
-TODO: describe keyword matching process
-
-Sending Messages
-----------------
-
+A case insensitive greedy match is performed on the start of every incoming
+message up to the first space in the message. For example, the messages
+`connect John Calvin` and `connected John Calvin` would both match the keyword
+`connect`, but only the second message would match the keyword `connected`.
 
+There is an additional check when creating new keywords - you cannot create a
+keyword that cause a match collision. For example, if `connect` is a keyword,
+you will be unable to create `con`, `conn` or `connected`, etc.

docs/getting_started.rst

@@ -8,7 +8,7 @@ TODO: release ansible playbook for deployment and add instructions
 Prerequisites
 -------------
 
-* *Required*:Twilio account with a purchased number
+* *Required*: Twilio account with a purchased number
 * *Required*: An SMTP server or Mailgun, Madrill, etc account for sending email notifications
 * *Optional*: A web app registered for authentication with a Google account
 * *Optional*: An Elvanto API Key for importing Elvanto groups
@@ -43,20 +43,22 @@ After you have successfully set up your copy of apostello you should create a su
 * Edit any settings and default responses you wish by clicking on the Site Configuration and Default Responses links TODO: link to docs
 * You can also set up authenitcation with Google now TODO: link to instructions
 * When you are done, sign out of the admin site and click `View Site` at the top of the page
-* Now set up a new user account.
-* You should receive a verification email in your inbox.
+* Now set up a new user account
+* You should receive a verification email in your inbox
 * Verify your email to gain access
 * Once you are in, you may see the not approved screen if you have not whitelisted any domains, you will have to return to the admin panel to authorise your email:
+  * Sign out of your account (menu on the top right of the screen)
+  * Return to the admin panel and log in with your superuser credentials
   * Click on `Users`
   * Click on the user account you created through the site
-  * Tick the `Staff Status` and `Superuser Status` boxes to give you access to everything, including the admin interface. Scroll down and save your changes.
+  * Tick the `Staff Status` and `Superuser Status` boxes to give your account access to everything, including the admin interface. Scroll down and save your changes.
   * *Optional:* delete the admin user you created with `createsuperuser`
+* Log out of the admin panel and return the normal site
+* Log in with your user account again
 * Now you can continue to set up apostello: import contacts, start sending messages, publicise your number, etc
 
 
 Google Authentication
 ~~~~~~~~~~~~~~~~~~~~~
 
-If you want to use Google authentication, then you need to follow the steps here.
-
-TODO: link to allauth
+If you want to let users sign in with Google, then you need to follow the steps `here <https://django-allauth.readthedocs.org/en/stable/providers.html#google>`_..