Skip to content

fix(amazonq): /docs -> /doc in readme #6131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 3, 2024
Merged

fix(amazonq): /docs -> /doc in readme #6131

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions packages/amazonq/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,39 @@
# Agent capabilities

### Implement new features

Copy link
Contributor Author

@jpinkney-aws jpinkney-aws Dec 3, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The pre-commit lint changed this, not sure why it wasn't caught before

`/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.
Loading