aws / aws/amazon-q-developer-cli

bug: README referencing 404 / invalid links and it's hard to get a sense of the layout of the project

Open
#2,021 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
2k
Forks
439
PR merge metrics
No merged PRs in 30d

Description

### Checks

- [x] I have searched [github.com/aws/amazon-q-developer-cli/issues](https://github.com/aws/amazon-q-developer-cli/issues?q=) and there are no duplicates of my issue

### Operating system

Any

### Expected behaviour

This is an amazing product. This and Claude Code I think are or could be maybe the React.js/Vue.js of Gen AI coding tools (h/t https://www.youtube.com/watch?v=0G1vd3Trj2U for that idea). That said I'd love if it were easier to understand the layout of the code and to figure out where to jump in. BTW I also agree with Bret Taylor that open source will likely win here re: AI tooling in general. So I'm super optimistic about this product.

But yeah these links in the README:

```
Several projects live here:

[autocomplete](https://github.com/aws/amazon-q-developer-cli/blob/main/packages/autocomplete) - The autocomplete react app
[dashboard](https://github.com/aws/amazon-q-developer-cli/blob/main/packages/dashboard-app) - The dashboard react app
[figterm](https://github.com/aws/amazon-q-developer-cli/blob/main/crates/figterm) - figterm, our headless terminal/pseudoterminal that intercepts the user’s terminal edit buffer.
[q_cli](https://github.com/aws/amazon-q-developer-cli/blob/main/crates/q_cli) - the q CLI, allows users to interface with Amazon Q Developer from the command line
[fig_desktop](https://github.com/aws/amazon-q-developer-cli/blob/main/crates/fig_desktop) - the Rust desktop app, uses [tao](https://docs.rs/tao/latest/tao/)/[wry](https://docs.rs/wry/latest/wry/) for windowing/webviews
[fig_input_method](https://github.com/aws/amazon-q-developer-cli/blob/main/crates/fig_input_method) - The input method used to get cursor position on macOS
[vscode](https://github.com/aws/amazon-q-developer-cli/blob/main/extensions/vscode) - Contains the VSCode plugin needed for the Amazon Q Developer for command line to work in VSCode
[jetbrains](https://github.com/aws/amazon-q-developer-cli/blob/main/extensions/jetbrains) - Contains the VSCode plugin needed for the Amazon Q Developer for command line to work in Jetbrains IDEs
```

all go to 404s. Can we use Q CLI to organize this more? Seems like some of these links are referencing a previous TypeScript version/packages. I'll submit a PR (using coding assistance to summarize the current code base) for reference in case folks want to use it (simple prompt: can we create an updated README.md and codebase-summary.md based on the actual code since I think some things have gotten moved around). Thanks!

### Actual behaviour

Onboarding to be smoother

### Steps to reproduce

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.