Skip to content

Commit

Permalink
fix(amazonq): /docs -> /doc in readme (#6131)
Browse files Browse the repository at this point in the history
## Problem
/docs should be /doc

## Solution
fix it

---

<!--- REMINDER: Ensure that your PR meets the guidelines in
CONTRIBUTING.md -->

License: I confirm that my contribution is made under the terms of the
Apache 2.0 license.
  • Loading branch information
jpinkney-aws authored Dec 3, 2024
1 parent 487941e commit c4f965f
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions packages/amazonq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,39 @@
# Agent capabilities

### Implement new features

`/dev` to task Amazon Q with generating new code across your entire project and implement features.

### Generate documentation
`/docs` to task Amazon Q with writing API, technical design, and onboarding documentation.

`/doc` to task Amazon Q with writing API, technical design, and onboarding documentation.

### Automate code reviews

`/review` to ask Amazon Q to perform code reviews, flagging suspicious code patterns and assessing deployment risk.

### Generate unit tests

`/test` to ask Amazon Q to generate unit tests and add them to your project, helping you improve code quality, fast.

### Transform workloads

`/transform` to upgrade your Java applications in minutes, not weeks.

<br>

# Core features

### Inline chat

Seamlessly initiate chat within the inline coding experience. Select a section of code that you need assistance with and initiate chat within the editor to request actions such as "Optimize this code", "Add comments", or "Write tests".

### Chat

Generate code, explain code, and get answers about software development.

### Inline suggestions

Receive real-time code suggestions ranging from snippets to full functions based on your comments and existing code.

[_15+ languages supported including Python, TypeScript, Rust, Terraform, AWS Cloudformation, and more_](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/q-language-ide-support.html)
Expand All @@ -51,4 +59,4 @@ Attribute code from Amazon Q that is similar to training data. When code suggest

# Troubleshooting & feedback

[File a bug](https://github.com/aws/aws-toolkit-vscode/issues/new?assignees=&labels=bug&projects=&template=bug_report.md) or [submit a feature request](https://github.com/aws/aws-toolkit-vscode/issues/new?assignees=&labels=feature-request&projects=&template=feature_request.md) on our Github repository.
[File a bug](https://github.com/aws/aws-toolkit-vscode/issues/new?assignees=&labels=bug&projects=&template=bug_report.md) or [submit a feature request](https://github.com/aws/aws-toolkit-vscode/issues/new?assignees=&labels=feature-request&projects=&template=feature_request.md) on our Github repository.

0 comments on commit c4f965f

Please sign in to comment.