Merge pull request #5 from Chicago/dev

Updated layout and format

docs/index.md

@@ -1,5 +1,7 @@
 # Open311 API Documentation
 
+Chicago's [311 system](https://www.cityofchicago.org/311) gives residents a central phone number and location to request city services, report non-emergency issues, and get updates on city work. Open311 provides greater access and transparency since it allows developers to build apps and websites on top of Chicago's 311 system. Open311 is a REST-based Application Programmer Inferface (API) that lets developers requests directly to 311 and also retrieve status on existing service requests. 
+
 ## Authentication
 
 You may need an API Key in order to call some endpoints in Chicago's Open311 system. This is indicated in the documentation by a field labeled **"Requires API Key?"**.
@@ -23,6 +25,12 @@ Visit the above URL to request an API key from the test Open311 system. Your req
 ### Production
 [Request production API key](http:https://311api.cityofchicago.org/open311/v2/apps/new) may be requested after successfully using a test API key.
 
+!!! attention
+ All requests for API keys must first be tested in the development environment.
+ Use the same application name as used with the test key to ensure quick turn-around
+ for your request. When testing, ensure that your application can successfully write
+ and retrieve service requests.
+
 Production API keys may only be requested after successfully testing with a test API key. The API Key application you submit will need to be reviewed and approved by City of Chicago Staff to ensure compliance with the [Terms of Service](tos/).
 
 ## Service Request Meta Data

docs/service_list.md

@@ -19,11 +19,11 @@ Provide a list of acceptable 311 service request types and their associated serv
 ## Response Parameters
 
 | Argument | Description |
-|----------------|------------------------------------------------------------------------|
+|:---------------|:-----------------------------------------------------------------------|
 | `service_code` | The unique identifier for the service request type. |
 | `service_name` | The human readable name of the service request type. |
-| `description` | A brief description of the service request type.  |
-| `metadata` | Determines whether there are additional form fields for this service type. |
-| `type` | Explains how this deals with the Open311 service request ID dance. |
-| `keywords` | A comma separated list of tags or keywords to help users identify the request type. This can provide synonyms of the service_name and group. |
-| `group` | A category to group this service type within. This provides a way to group several service request types under one category such as 'sanitation'. |
+| `description`  | A brief description of the service request type. |
+| `metadata`  | Determines whether there are additional form fields for this service type. |
+| `type`  | Explains how this deals with the Open311 service request ID dance. |
+| `keywords`  | A comma separated list of tags or keywords to help users identify the request type. This can provide synonyms of the service_name and group. |
+| `group`  | A category to group this service type within. This provides a way to group several service request types under one category such as 'sanitation'. |

mkdocs.yml

@@ -1,10 +1,11 @@
+
+# Site Information
 site_name: Open311 API
-theme: readthedocs
-site_url: http:https://dev.cityofchicago.org/docs/open311
-repo_url: http:https://github.com/Chicago/open311-api-docs
-site_description: Open311 API Documentation
 site_author: City of Chicago
+site_description: Open311 API Documentation
+site_url: http:https://dev.cityofchicago.org/docs/open311
 
+# Page Tree
 pages:
 - Home: index.md
 - Metadata:
@@ -16,4 +17,35 @@ pages:
  - post_service_request: post_service_request.md
 - 'Terms of Service': 'tos.md'
 
+# Copyright
 copyright: Copyright &copy; 2016-2017 <a href="http:https://www.cityofchicago.org">City of Chicago</a> and licensed under <a href="http:https://creativecommons.org/licenses/by-sa/4.0/">Creative Commons Attribution-ShareAlike 4.0 International</a>.
+
+# Repository Information
+repo_name: Chicago/open311-api-docs
+repo_url: http:https://github.com/Chicago/open311-api-docs
+
+# Theme
+theme_dir: 'theme/material'
+site_favicon: 'assets/images/favicon.png'
+extra:
+ logo: 'assets/images/city-seal-inverse-small.png'
+ palette:
+ primary: 'blue grey'
+ accent: 'light blue'
+ social:
+ - type: 'twitter'
+ link: 'https://twitter.com/ChicagoCDO'
+ - type: 'github'
+ link: 'https://github.com/Chicago'
+ - type: 'envelope-o'
+ link: 'mailto:[email protected]'
+ - type: 'home'
+ link: 'http:https://dev.cityofchicago.org'
+
+# Google Analytics
+# google_analytics:
+
+# Extensions
+markdown_extensions:
+ - admonition
+ - toc(permalink=true)

theme/material/404.html

@@ -0,0 +1,4 @@
+{% extends "base.html" %}
+{% block content %}
+ <h1>404 - Not found</h1>
+{% endblock %}