more improvements (#172)

Author: marcuskohlberg

hello-world/README.md

@@ -24,9 +24,6 @@ Run this command from your application's root folder:
 ```bash
 encore run
 ```
-
-While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to view Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
-
 ## Using the API
 
 To see that your app is running, you can ping the API.
@@ -35,7 +32,11 @@ To see that your app is running, you can ping the API.
 curl http://localhost:4000/hello/World
 ```
 
-When you ping the API, you will see traces and logs appearing in the local development dashboard: <http://localhost:9400/>
+## Local Development Dashboard
+
+While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
+
+Here you can see traces for all requests that you made while using the frontend, see your architecture diagram, and view API documentation in the Service Catalog.
 
 ## Deployment
 

slack-bot/README.md

@@ -79,6 +79,13 @@ encore run
 
 **Note:** This app doesn't do much when running locally, you need to deploy it (see below) for Slack to be able to communicate with the program and for the bot to work.
 
+
+## Local Development Dashboard
+
+While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
+
+Here you can see traces for all requests that you made while using the frontend, see your architecture diagram, and view API documentation in the Service Catalog.
+
 ## Deployment
 
 ### Self-hosting

sql-database/README.md

@@ -95,33 +95,59 @@ To run the application locally, make sure you have [Docker](https://docker.com)
 encore run
 ```
 
-## Using the API in the example
+## Using the API
 
 To see that your app is running, you can ping the API.
 
 ```bash
 curl http://localhost:4000/hello/There
 ```
 
-## Open the developer dashboard
+## Local Development Dashboard
 
-While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to view Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
+While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
+
+Here you can see traces for all requests that you made while using the frontend, see your architecture diagram, and view API documentation in the Service Catalog.
+
+## Connecting to databases
+
+You can connect to your databases via psql shell:
+
+```bash
+encore db shell <database-name> --env=local --superuser
+```
+
+Learn more in the [CLI docs](https://encore.dev/docs/develop/cli-reference#database-management).
 
 ## Deployment
 
-Deploy your application to a staging environment in Encore's free development cloud:
+### Self-hosting
+
+See the [self-hosting instructions](https://encore.dev/docs/self-host/docker-build) for how to use `encore build docker` to create a Docker image and configure it.
+
+### Encore Cloud Platform
+
+Deploy your application to a free staging environment in Encore's development cloud using `git push encore`:
 
 ```bash
 git add -A .
 git commit -m 'Commit message'
 git push encore
 ```
 
-Then head over to the [Cloud Dashboard](https://app.encore.dev) to monitor your deployment and find your production URL.
+You can also open your app in the [Cloud Dashboard](https://app.encore.dev) to integrate with GitHub, or connect your AWS/GCP account, enabling Encore to automatically handle cloud deployments for you.
+
+## Link to GitHub
+
+Follow these steps to link your app to GitHub:
 
-From there you can also connect your own AWS or GCP account to use for deployment.
+1. Create a GitHub repo, commit and push the app.
+2. Open your app in the [Cloud Dashboard](https://app.encore.dev).
+3. Go to **Settings ➔ GitHub** and click on **Link app to GitHub** to link your app to GitHub and select the repo you just created.
+4. To configure Encore to automatically trigger deploys when you push to a specific branch name, go to the **Overview** page for your intended environment. Click on **Settings** and then in the section **Branch Push** configure the **Branch name** and hit **Save**.
+5. Commit and push a change to GitHub to trigger a deploy.
 
-Now off you go into the clouds!
+[Learn more in the docs](https://encore.dev/docs/how-to/github)
 
 ## Testing
 

ts/hello-world/README.md

@@ -24,9 +24,6 @@ Run this command from your application's root folder:
 ```bash
 encore run
 ```
-
-While `encore run` is running, open <http://localhost:9400/> to view Encore's [local development dashboard](https://encore.dev/docs/observability/dev-dash).
-
 ## Using the API
 
 To see that your app is running, you can ping the API.
@@ -35,7 +32,11 @@ To see that your app is running, you can ping the API.
 curl http://localhost:4000/hello/World
 ```
 
-When you ping the API, you will see traces and logs appearing in the local development dashboard: <http://localhost:9400/>
+## Local Development Dashboard
+
+While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
+
+Here you can see traces for all requests that you made while using the frontend, see your architecture diagram, and view API documentation in the Service Catalog.
 
 ## Deployment
 

ts/slack-bot/README.md

@@ -2,6 +2,10 @@
 
 This is an Encore starter application for a Slack bot. It brings the greatness of the cowsay utility to Slack!
 
+## Build from scratch with a tutorial
+
+If you prefer to built it yourself, check out the [written tutorial](https://encore.dev/docs/tutorials/slack-bot) to learn how to build this application from scratch.
+
 ## Prerequisites 
 
 **Install Encore:**
@@ -75,6 +79,12 @@ encore run
 
 **Note:** This app doesn't do much when running locally, you need to deploy it (see below) for Slack to be able to communicate with the program and for the bot to work.
 
+## Local Development Dashboard
+
+While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
+
+Here you can see traces for all requests that you made while using the frontend, see your architecture diagram, and view API documentation in the Service Catalog.
+
 ## Deployment
 
 ### Self-hosting

ts/uptime/README.md

@@ -82,6 +82,16 @@ While `encore run` is running, open [http://localhost:9400/](http://localhost:94
 
 Here you can see traces for all requests that you made while using the frontend, see your architecture diagram, and view API documentation in the Service Catalog.
 
+## Connecting to databases
+
+You can connect to your databases via psql shell:
+
+```bash
+encore db shell <database-name> --env=local --superuser
+```
+
+Learn more in the [CLI docs](https://encore.dev/docs/develop/cli-reference#database-management).
+
 ## Deployment
 
 ### Self-hosting

ts/url-shortener/README.md

@@ -34,6 +34,26 @@ Before running your application, make sure you have Docker installed and running
 encore run
 ```
 
+## Using the API
+
+### url.shorten — Shortens a URL and adds it to the database
+
+```bash
+curl 'http://127.0.0.1:4000/url' -d '{"url":"https://google.com"}'
+```
+
+### url.get — Gets a URL from the database using a short ID
+
+```bash
+curl 'http://127.0.0.1:4000/url/:id'
+```
+
+### url.list — Lists all shortened URLs
+
+```bash
+curl 'http://127.0.0.1:4000/url'
+```
+
 ## Open the developer dashboard
 
 While `encore run` is running, open <http://localhost:9400/> to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
@@ -50,6 +70,16 @@ curl 'http://localhost:4000/url' -d '{"url":"https://news.ycombinator.com"}'
 
 When you ping the API, you will see traces and logs appearing in the local development dashboard: <http://localhost:9400/>
 
+## Connecting to databases
+
+You can connect to your databases via psql shell:
+
+```bash
+encore db shell <database-name> --env=local --superuser
+```
+
+Learn more in the [CLI docs](https://encore.dev/docs/develop/cli-reference#database-management).
+
 ## Deployment
 
 ### Self-hosting

uptime/README.md

@@ -49,12 +49,6 @@ encore secret set --type local,dev,pr,prod SlackWebhookURL
 
 **Note:** Cron Jobs do not execute when running locally.
 
-## Local Development Dashboard
-
-While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
-
-Here you can see traces for all requests, see the application architecture diagram, and see API documentation in the Service Catalog.
-
 ## View the frontend
 
 While `encore run` is running, head over to [http://localhost:4000/frontend/](http://localhost:4000/frontend/) to view the frontend for your uptime monitor.
@@ -81,6 +75,22 @@ Get the current status of all tracked sites:
 curl 'http://localhost:4000/status'
 ```
 
+## Local Development Dashboard
+
+While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
+
+Here you can see traces for all requests you've made, see the application architecture diagram, and see API documentation in the Service Catalog.
+
+## Connecting to databases
+
+You can connect to your databases via psql shell:
+
+```bash
+encore db shell <database-name> --env=local --superuser
+```
+
+Learn more in the [CLI docs](https://encore.dev/docs/develop/cli-reference#database-management).
+
 ## Deployment
 
 ### Self-hosting

url-shortener/README.md

@@ -35,18 +35,35 @@ encore run
 
 ## Using the API
 
-To see that your app is running, you can ping the API to shorten a url.
+
+### url.shorten — Shortens a URL and adds it to the database
 
 ```bash
 curl 'http://localhost:4000/url' -d '{"URL":"https://news.ycombinator.com"}'
 ```
 
+### url.get — Gets a URL from the database using a short ID
+
+```bash
+curl 'http://127.0.0.1:4000/url/:id'
+```
+
 ## Open the developer dashboard
 
 While `encore run` is running, open [http://localhost:9400/](http://localhost:9400/) to access Encore's [local developer dashboard](https://encore.dev/docs/observability/dev-dash).
 
 Here you can see traces for all your requests, view your architecture diagram, and see API docs in the Service Catalog.
 
+## Connecting to databases
+
+You can connect to your databases via psql shell:
+
+```bash
+encore db shell <database-name> --env=local --superuser
+```
+
+Learn more in the [CLI docs](https://encore.dev/docs/develop/cli-reference#database-management).
+
 ## Deployment
 
 ### Self-hosting