aws / aws/amazon-q-developer-cli

Multiple documentation issues

Aperta
#2,069 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
issue
Lingua principale
Rust
Stelle
2k
Fork
439
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia riproducendo le segnalazioni con q chat, q inline disable e q doctor su Amazon Linux 2, quindi traccia dove vengono forniti l'URL della documentazione di q doctor e i riferimenti alla documentazione della chat. Il lavoro è completato quando i link segnalati portano a una documentazione pertinente e aggiornata e q chat fornisce indicazioni coerenti sulle funzionalità più recenti della CLI.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
linux, shell
Ambito
cli, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.