Tidy documentation

navapbc · May 22, 2024 · 88af1d8 · 88af1d8
1 parent 6c38b1a
commit 88af1d8
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ See [`navapbc/platform`](https://github.com/navapbc/platform) for other template
 ## Features
 
 - [U.S. Web Design System](https://designsystem.digital.gov/) for themeable styling and a set of common components
-- Integration with AWS services, including
+- Integration with AWS services, including:
   - Database integration with AWS RDS Postgresql using UUIDs
   - Active Storage configuration with AWS S3
   - Action Mailer configuration with AWS SES
@@ -49,11 +49,7 @@ To get started using the template application on your project:
     curl https://raw.githubusercontent.com/navapbc/template-application-rails/main/template-only-bin/download-and-install-template.sh | bash -s -- <commit_hash>
     ```
 2. [Follow the steps in `app-rails/README.md`](./app-rails/README.md) to set up the application locally.
-3. Optional, if using the Platform infra template: [Follow the steps in the `template-infra` README](https://github.com/navapbc/template-infra#installation) to set up the various pieces of your infrastructure.
-
-## Getting started
-
-Now that you're all set up, you're now ready to [get started](./app-rails/README.md).
+3. Optional, if using the Platform infrastructure template: [Follow the steps in the `template-infra` README](https://github.com/navapbc/template-infra#installation) to set up the various pieces of your infrastructure.
 
 ## Updates
 

diff --git a/app-rails/README.md b/app-rails/README.md
@@ -17,7 +17,7 @@ This is a [Ruby on Rails](https://rubyonrails.org/) application. It includes:
 
 As a Rails app, much of the directory structure is driven by Rails conventions. We've also included directories for common patterns, such as adapters, form objects and services.
 
-**[Refer to the Software Architecture doc for more detail](../docs/app-rails/software-architecture.md)**
+**[Refer to the Software Architecture doc for more detail](../docs/app-rails/software-architecture.md).**
 
 Below are the primary directories to be aware of when working on the app:
 
@@ -49,6 +49,7 @@ Below are the primary directories to be aware of when working on the app:
 
 - A container runtime (e.g. [Docker](https://www.docker.com/) or [Finch](https://github.com/runfinch/finch))
   - By default, `docker` is used. To change this, set the `CONTAINER_CMD` variable to `finch` (or whatever your container runtime is) in the shell.
+- An AWS account with a Cognito User Pool and App Client configured
 
 ### 💾 Setup