Cleanup

ohmygois · Jan 28, 2024 · 98d679d · 98d679d
1 parent 23ba0d1
commit 98d679d
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 35 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -11,7 +11,7 @@ We recommend you look through these docs together.
 | ---------------------------------------------------- | ------------------------------ |
 | [Full-Stack Overview](./docs/full-stack_overview.md) | Frontend/Backend communication |
 | [Authentication](./docs/authentication.md)           | JSON Web Tokens                |
-| [Accessibility](./docs/accessibility.md) (TODO)      | Writing inclusive Web Pages    |
+
 
 ## Reference Docs:
 
@@ -24,7 +24,3 @@ come across something in the project you don't understand.
 | [Frontend Structure](./docs/frontend_structure.md)        | `App.jsx`, routes, pages, components          |
 | [Environment Variables](./docs/environment_variables.md)  | `process.env`,`import.meta.env`, `.env` files |
 | [Modules](./docs/modules.md)                              | `import` vs. `require`                        |
-| [Route Handlers](./docs/route_handlers.md) (TODO)         | `req`, `res`, middleware                      |
-| [MongoDB Models](./docs/mongodb_models.md) (TODO)         | Schemas                                       |
-| [Fetching in React](./docs/fetching_in_react.md) (TODO)   | `useEffect`                                   |
-| [Deploying](./docs/deploying.md) (TODO)                   | Using Render to deploy Acebook                |
diff --git a/README.md b/README.md
@@ -97,11 +97,11 @@ For an explanation of these environment variables, see the documentation.
 
 ### How to run the server and use the app
 
-1. Start the server application (in the `api` directory)
+1. Start the server application (in the `api` directory) in dev mode:
 
 ```
 ; cd api
-; npm start
+; npm run dev
 ```
 
 2. Start the front end application (in the `frontend` directory)
@@ -110,7 +110,7 @@ In a new terminal session...
 
 ```
 ; cd frontend
-; npm dev
+; npm run dev
 ```
 
 You should now be able to open your browser and go to

diff --git a/docs/accessibility.todo.md b/docs/accessibility.todo.md
diff --git a/docs/authentication.md b/docs/authentication.md
@@ -19,7 +19,7 @@ implemented authentication yet, that's not going to impede you right now.
    the backend).
 7. When the user logs out, the front end discards the token.
 
-![authentication flow diagram](./diagrams/auth_flow.png)
+![diagram of the above authentication flow](./diagrams/auth_flow.png)
 
 ## What is a JSON Web Token?
 

diff --git a/docs/deploying.todo.md b/docs/deploying.todo.md
diff --git a/docs/fetching_in_react.todo.md b/docs/fetching_in_react.todo.md
diff --git a/docs/full-stack_overview.md b/docs/full-stack_overview.md
@@ -111,13 +111,13 @@ And the body of the response would look like this.
 ```
 
 Here's a diagram of the above <br> <br>
-![a diagram of client/server applications](./diagrams/project_communication.png)
+![a diagram of the client/server application with the client making a request to the server and receiving a response](./diagrams/project_communication.png)
 <br> <br>
 
 Once received by the React FE, the JSON in the response body is used to render a
 list of posts on the page.
 
-![response body mapped onto a page](./diagrams/response_parsing.png)
+![response body mapped onto a page with the message of each post being displayed on a new line](./diagrams/response_parsing.png)
 
 This architectural pattern is has a number of advantages. For example, it allows
 teams to build multiple front ends, all of which use the same backend API. You

diff --git a/docs/mongodb_models.todo.md b/docs/mongodb_models.todo.md
diff --git a/docs/route_handlers.todo.md b/docs/route_handlers.todo.md
diff --git a/frontend/package-lock.json b/frontend/package-lock.json