Skip to content

Commit d10e68a

Browse files
authored
Enhance installation instructions (#13)
*Issue #, if available:* *Description of changes:* This PR improves the README documentation by enhancing the installation instructions to make them more user-friendly. By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
1 parent ad96ebe commit d10e68a

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Please carefully follow all the steps below. If you encounter any issues, we're
3232
### 1. Clone the Repository
3333

3434
```bash
35-
git clone https://github.com/aws-samples/sample-remote-swe-agents.git
36-
cd sample-remote-swe-agents
35+
git clone https://github.com/aws-samples/remote-swe-agents.git
36+
cd remote-swe-agents
3737
```
3838

3939
### 2. Run CDK Deploy
@@ -78,6 +78,7 @@ Now, you need to set up a Slack App to control agents through the Slack interfac
7878
3. Choose "From manifest"
7979
4. Use the provided Slack app manifest YAML file: [manifest.json](./resources/slack-app-manifest.json)
8080
- Please replace the endpoint URL (`https://redacted.execute-api.us-east-1.amazonaws.com`) with your actual URL
81+
- You can find your actual URL in the CDK deployment outputs as `SlackBoltEndpointUrl`
8182
5. Please make note of the following values:
8283
- Signing Secret (found in Basic Information)
8384
- Bot Token (found in OAuth & Permissions, after installing to your workspace)
@@ -97,11 +98,13 @@ aws ssm put-parameter \
9798
--name /remote-swe/slack/bot-token \
9899
--value "your-slack-bot-token" \
99100
--type String
101+
--overwrite
100102

101103
aws ssm put-parameter \
102104
--name /remote-swe/slack/signing-secret \
103105
--value "your-slack-signing-secret" \
104106
--type String
107+
--overwrite
105108
```
106109

107110
Replace `your-slack-bot-token` and `your-slack-signing-secret` with the actual values you obtained in the previous step. The parameters will be referenced from CDK.
@@ -115,14 +118,15 @@ To interact with GitHub, you need to setup GitHub integration. You have two opti
115118

116119
1. Go to [GitHub Settings > Developer settings > Personal access tokens](https://github.com/settings/tokens)
117120
2. Generate a new token (classic) with appropriate repository access
118-
* Required scopes: `read:org, repo, workflow`
121+
* Required scopes: `repo, workflow, read:org`
119122
* The more scopes you permit, the more various tasks agents can perform
120123
3. Create an SSM Parameter with the generated token string
121124
```bash
122125
aws ssm put-parameter \
123126
--name /remote-swe/github/personal-access-token \
124127
--value "your-access-token" \
125128
--type String
129+
--overwrite
126130
```
127131

128132
> [!NOTE]
@@ -194,7 +198,7 @@ You can now access all features from Slack. Simply mention the Slack app and sta
194198

195199
When you start an agent, your instruction should include at least the below content:
196200

197-
1. Which GitHib repository should they see
201+
1. Which GitHub repository should they see
198202
2. Describe the feature or bug you want to solve
199203
3. What file should they check first (file path would be the best, but only keywords can also work)
200204

0 commit comments

Comments
 (0)