juliebro · juliebro · Jun 27, 2025 · Jun 16, 2025 · Jun 16, 2025 · Jun 18, 2025
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@
 docs/.DS_Store
 .DS_Store
 .DS_Store
+.DS_Store
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright © 2025 Julie Brodeur and Jeff Naemura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docs-planning/info-arch.md b/docs-planning/info-arch.md
@@ -1,6 +1,6 @@
 # Information architecture for orca-sightings-api docs
 
-*Draft 2*
+*Draft 3*
 
 ## `/docs`
 
@@ -24,7 +24,7 @@ Contains "index" file  `tutorials.md`.  Also includes:
 
 Supporting topics that are reused across other topics:
 
-- `set-up-dev-env.md` → how to set up the development environment
+- `set-up-dev-env.md` → how to set up the environment for using tutorials
 - `start-service.md` → how to start the Orca Sightings service
 
 ### `/reference`

diff --git a/docs-planning/portfolio-preso-juliebro-v1.pptx b/docs-planning/portfolio-preso-juliebro-v1.pptx
diff --git a/docs-planning/portfolio-preso-juliebro-v2.pdf b/docs-planning/portfolio-preso-juliebro-v2.pdf
diff --git a/docs-planning/~$portfolio-preso-juliebro-v1.pptx b/docs-planning/~$portfolio-preso-juliebro-v1.pptx
diff --git a/docs/.DS_Store b/docs/.DS_Store
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -16,6 +16,7 @@ nav_enabled: true
 #     The format for this property's value is <GitHub account>/<repo> 
 #   *** DO NOT CHANGE THIS VALUE
 remote_theme: just-the-docs/just-the-docs
+
 #   For information about this theme and its options, see: https://just-the-docs.com/
 #
 # These values describe aspects of the final documentation. How they are
@@ -123,9 +124,13 @@ liquid:
 back_to_top: true
 back_to_top_text: "Back to top"
 
+#
+# favicon for the browser tab
+favicon_ico: /images/favicon.png
+
 #
 #   !!! CHANGE THIS VALUE TO APPLY TO YOUR DOCUMENTATION
-footer_content: "Copyright &copy; 2025 Julie Brodeur (tech writer) and Jeff Naemura (subject matter expert)."
+footer_content: "Copyright &copy; 2025 Julie Brodeur (technical writer) and Jeff Naemura (subject matter expert). Distributed by an MIT license. This work is for educational and demonstration purposes only." 
 
 # - - - - - - - - - - - - - - - - 
 #
@@ -148,7 +153,7 @@ footer_content: "Copyright &copy; 2025 Julie Brodeur (tech writer) and Jeff Naem
 #         in the navigation, where 1 is the first entry, 2 is below 1, etc.
 #       See also https://just-the-docs.com/docs/navigation/main/order/
 #
-#   has_children: true
+#   has_children: true !!! Note: This is no longer required.
 #       Specifies if this topic has sub-topics. Value can be true or false.
 #       If the topic has sub-topics, the sub-topics must contain the parent
 #         property in their front matter and list the page name of the topic

diff --git a/docs/images/favicon.png b/docs/images/favicon.png
diff --git a/docs/index.md b/docs/index.md
@@ -11,7 +11,7 @@ This cloud-based service tracks the movements of orca pods around the San Juan I
 
 Using this service, orca enthusiasts can report the location and time of their sightings off the coast of any of the San Juan Islands, making it easy for others to sight these whales from land so they don't have to charter a boat. As a developer, you can include this service in your app.
 
-To get started, learn how to [set up your development environment](./tutorials/set-up-dev-env.md) and [list all sightings](./tutorials/quickstart.md) in the service, or jump down to learn more about the [user community](#user-community) and [features](#features).
+To get started, learn how to [set up your environment](./tutorials/set-up-dev-env.md) and [list all sightings](./tutorials/quickstart.md) in the service, or jump down to learn more about the [user community](#user-community) and [features](#features).
 
 ![ Photo of orca whales](./images/orca-photo.png)
 
@@ -21,15 +21,12 @@ The orca whale watching community is niche but active. It includes a variety of
 
 ## Features
 
-{: .comment }
-This section includes links to the relevant tutorials for each action. Most of the links don't work now.
-
 The Orca Sightings service is a RESTful API designed to support this community. It offers two main resources: `/users` and `/sightings`. Each resource supports standard HTTP methods, including GET, POST, PUT, PATCH, and DELETE, so your app can perform the following actions:
 
-- [Create new user profiles](./tutorials/add-user.md) and [log new orca sightings](./tutorials/add-new-sighting.md).
-- [Retrieve all or specific user](./tutorials/get-user.md) and [sighting records](./tutorials/get-sighting.md).
+- [Create new user profiles](./tutorials/add-user.md) and [log new orca sightings](./tutorials/add-sighting.md).
+- [Retrieve all or specific user](./tutorials/list-users.md) and [sighting records](./tutorials/quickstart.md).
 - [Update existing user information](./tutorials/update-user.md) and [sighting details](./tutorials/update-sighting.md).
 - [Delete user accounts](./tutorials/delete-user.md) and [sighting entries](./tutorials/delete-sighting.md).
 
-{: .warning }
+{: .note }
 This is a simulated REST interface only for the demonstration of API documentation.
diff --git a/docs/reference/sightings/sightings-delete.md b/docs/reference/sightings/sightings-delete.md
@@ -30,11 +30,11 @@ Also see:
 
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Required: the `id` of the user you want to delete. Specify this in the endpoint.
 
-For a full description of all `/sightings` properties, see [`/sightings` resource](./sightings-resource.md#parameters).
+For a full description of all `/sightings` properties, see [`/sightings` resource](./sightings-resource.md#properties).
 
 ## Request body
 

diff --git a/docs/reference/sightings/sightings-get.md b/docs/reference/sightings/sightings-get.md
@@ -32,11 +32,11 @@ Also see:
 
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Optional: the `id` of a specific sighting to list.
 
-For a full description of all `/sightings` properties, see [`/sightings` resource](./sightings-resource.md#parameters).
+For a full description of all `/sightings` properties, see [`/sightings` resource](./sightings-resource.md#properties).
 
 ## Headers
 

diff --git a/docs/reference/sightings/sightings-patch.md b/docs/reference/sightings/sightings-patch.md
@@ -27,13 +27,13 @@ Also see:
 
 `{base_url}/sightings/{id}`
 
-## Parameters
+## Properties
 
 Required: specify a sighting `id`.
 
 Optional, but you should include at least one: `user_id`, `pod`, `time`, and `location`.
 
-For a description of these properties, see [`/sightings` resource](./sightings-resource.md#parameters).
+For a description of these properties, see [`/sightings` resource](./sightings-resource.md#properties).
 
 ## Headers
 

diff --git a/docs/reference/sightings/sightings-post.md b/docs/reference/sightings/sightings-post.md
@@ -31,13 +31,13 @@ Also see:
 
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Optional, but recommended: `user_id`, `pod`, `time`, and `location`. The service automatically assigns the new user a unique `id`.
 
 > If you don't include any data in your request, the server creates an empty sighting with a unique ID.
 
-For a description of these parameters, see [`/sightings` resource](./sightings-resource.md#parameters).
+For a description of these properties, see [`/sightings` resource](./sightings-resource.md#properties).
 
 ## Headers
 

diff --git a/docs/reference/sightings/sightings-put.md b/docs/reference/sightings/sightings-put.md
@@ -29,16 +29,16 @@ Also see:
 
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Required: specify the `id` of the sighting you want to update in the endpoint.
 
-Optional: you should include all: you can use the following parameters to update a sighting: `user_id`, `pod`, `time`, and `location`.
+Optional: you should include all: you can use the following properties to update a sighting: `user_id`, `pod`, `time`, and `location`.
 
 {: .note }
 If you don't include the full data in your request, the server creates the sighting again with no data in that field. Likewise, if you don't include any data in your request, the server creates an empty sighting with the existing ID.
 
-For a description of these parameters, see [`/sightings` resource](./sightings-resource.md#parameters).
+For a description of these properties, see [`/sightings` resource](./sightings-resource.md#properties).
 
 ## Headers
 

diff --git a/docs/reference/sightings/sightings-resource.md b/docs/reference/sightings/sightings-resource.md
@@ -23,7 +23,7 @@ Also see the [`/users` resource](../users/users-resource.md).
 
 Also see [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Example of a full `/sightings` resource:
 
@@ -37,12 +37,12 @@ Example of a full `/sightings` resource:
 }
 ```
 
-Description of resource parameters:
+Description of resource properties:
 
-| Parameter | Type      | Description                                                  | Example                        |
+| Property | Type      | Description                                                  | Example                        |
 | ---------- | --------- | ------------------------------------------------------------ | ------------------------------ |
 | `id`       | `integer` | Unique identifier for the sighting. Read-only and automatically generated. | `1`                            |
-| `user_id`  | `integer` | The ID of the user who reported the sighting, as described in the [`/users` resource](../users-resource/users-resource.md). | `1`                            |
+| `user_id`  | `integer` | The ID of the user who reported the sighting, as described in the [`/users` resource](../users/users-resource.md). | `1`                            |
 | `pod`      | `string`  | The identified pod of orca. Available attributes are `J-pod`, `K-pod`, `T49A`, and `unknown`). | `"J-pod"`                      |
 | `time`     | `string`  | The timestamp of the sighting in [ISO 8601 format](../iso-8601-format.md). | `"2025-05-03T10:00"`           |
 | `location` | `string`  | The location where the sighting occurred.                    | `"Lime Kiln Point State Park"` |

diff --git a/docs/reference/users/users-delete.md b/docs/reference/users/users-delete.md
@@ -34,11 +34,11 @@ Also see:
 
 `Content-Type: application/json`
 
-## Parameters
+## Properties
 
 Required: the `id` of the user you want to delete. Specify this in the endpoint.
 
-For a full description of all `/users` properties, see [`/users` resource](./users-resource.md#parameters).
+For a full description of all `/users` properties, see [`/users` resource](./users-resource.md#properties).
 
 ## Request body
 

diff --git a/docs/reference/users/users-get.md b/docs/reference/users/users-get.md
@@ -28,11 +28,11 @@ Also see:
 
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Optional: the `id` of a specific user to list.
 
-For a description of all parameters, see [`/users` resource](./users-resource.md#parameters).
+For a description of all properties, see [`/users` resource](./users-resource.md#properties).
 
 ## Request body
 

diff --git a/docs/reference/users/users-patch.md b/docs/reference/users/users-patch.md
@@ -10,7 +10,7 @@ nav_order: 4
 - TOC
 {:toc}
 
-# `PATCH /users`: Update some of the details about a user
+# `PATCH /users` update some of the details about a user
 
 Updates some of the details about a user.
 
@@ -19,7 +19,7 @@ Also see:
 - [Update all or part of a user entry: a tutorial](../../tutorials/update-user.md)
 - [GET: List all users](./users-get.md)
 - [GET: Get user by id](./users-get.md)
-- [PATCH: Update part of a sighting](../sightings-resource/sightings-patch.md)
+- [PATCH: Update part of a sighting](../sightings/sightings-patch.md)
 
 ## Method
 
@@ -33,11 +33,11 @@ Also see:
 
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Required: the `id` of the user you want to update.
 
-For a description of all parameters, see [`/users` resource](./users-resource.md#parameters).
+For a description of all properties, see [`/users` resource](./users-resource.md#properties).
 
 ## Headers
 

diff --git a/docs/reference/users/users-post.md b/docs/reference/users/users-post.md
@@ -30,11 +30,11 @@ Also see:
 
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
-Optional, you should include all:  `first_name`, `last_name`, and `email`. The service automatically assigns the new user a unique `id`.
+Optional, but you should include all:  `first_name`, `last_name`, and `email`. The service automatically assigns the new user a unique `id`.
 
-For a description of these properties, see [`/users` resource](./users-resource.md#parameters).
+For a description of these properties, see [`/users` resource](./users-resource.md#properties).
 
 ## Headers
 
@@ -44,7 +44,7 @@ For a description of these properties, see [`/users` resource](./users-resource.
 
 ### cURL example
 
-Shows creating a new user named Ben Waters.
+Creates a new user named Ben Waters.
 
 ```shell
 curl -X POST \
@@ -55,7 +55,7 @@ curl -X POST \
 
 ### Postman example
 
-Shows creating a new user named Ben Waters.
+Creates a new user named Ben Waters.
 
 #### Request builder method and endpoint
 

diff --git a/docs/reference/users/users-put.md b/docs/reference/users/users-put.md
@@ -28,7 +28,7 @@ Updates the entire user record for the specified `id`.
 Also see:
 - [Base URL](../base-url.md)
 
-## Parameters
+## Properties
 
 Required: the `id` of the user you want to update.
 
@@ -37,7 +37,7 @@ Optional, you should include all: `first_name`, `last_name`, and `email`.
 {: .warning }
 If you don't include this data in your request, the server creates the user again with no data in that field. Likewise, if you don't include any data in your request, the server creates an empty user with the existing ID.
 
-For a description of these properties, see [`/users` resource](./users-resource.md#parameters).
+For a description of these properties, see [`/users` resource](./users-resource.md#properties).
 
 ## Headers
 

diff --git a/docs/reference/users/users-resource.md b/docs/reference/users/users-resource.md
@@ -23,7 +23,7 @@ Also see [`/sightings` resource](../sightings/sightings-resource.md).
 
 Also see [Base URL](../base-url.md).
 
-## Parameters
+## Properties
 
 Shows an example of a full `/users` resource:
 
@@ -36,9 +36,9 @@ Shows an example of a full `/users` resource:
 }
 ```
 
-Describes all parameters available in the `/users` resource:
+Describes all properties available in the `/users` resource:
 
-| Parameter     | Type      | Description                                                  | Example                  |
+| Property     | Type      | Description                                                  | Example                  |
 | ------------ | --------- | ------------------------------------------------------------ | ------------------------ |
 | `last_name`  | `string`  | The user's last name.                                        | `"Marsh"`                |
 | `first_name` | `string`  | The user's first name.                                       | `"Stan"`                 |