aws / aws/amazon-q-developer-cli

Multiple documentation issues

Offen
#2,069 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
issue
Vorherrschende Sprache
Rust
Sterne
2k
Forks
439
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### 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

Linux 5.10.237-211.949.amzn2int.x86_64 - Amazon Linux 2

### Expected behaviour

````bash
➜ ~ q --version
q 1.12.0
````

1. Amazon Q CLI chat is not aware of its own functionality

Asking q about its own functionality should give me consistent answers based on its latest release docs.

2. Outdated docs links provided by Amazon Q CLI subcommands:

Any documentation URL provided by q chat or q cli subcommands should return correct URLs for solving issues or checking the documentation.

### Actual behaviour

1. Amazon Q CLI chat is not aware of its own functionality

I asked it about how to disable the q cli autocomplete and it returned wrong/outdated information. While I was able to disable autocomplete via `q inline disable`, when asking it to `q chat` its responses didn't work.

2. Outdated docs links provided by q subcommands:

I ran `q doctor` which resulted in the below:

````bash
➜ ~ q doctor

● /home/brunosiq/.bashrc does not source post integration last
● Could not read sshd_config, check https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete-ssh.html for more info
● Inline is disabled, to re-enable run: q inline enable
✔ Everything looks good!

Amazon Q still not working? Run q issue to let us know!
````

The link https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-autocomplete-ssh.html goes to https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/what-is.html which is not helpful.

### Steps to reproduce

_No response_

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die Berichte mit q chat, q inline disable und q doctor unter Amazon Linux 2 zu reproduzieren. Verfolge anschließend, wo die Dokumentations-URL von q doctor und die Verweise auf die Chat-Dokumentation bereitgestellt werden. Als abgeschlossen gilt die Aufgabe, wenn die gemeldeten Links zu relevanter, aktueller Dokumentation führen und q chat konsistente Hinweise zur neuesten CLI-Funktionalität gibt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
linux, shell
Bereich
cli, documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.