documentation Issue #1968: Added README content to docs site including 'Currently supported' section #2013
Conversation
mrjones-plip
left a comment
mrjones-plip
left a comment
There was a problem hiding this comment.
Looking really good - thanks @arushi2702 !
I've added some early feedback, but otherwise take your time and ping me when you're ready for a formal review.
| ### Zsh completion | ||
| To enable tab completion in zsh, add the following to your `~/.zshrc` file: | ||
| ```shell | ||
| eval "$(cht-conf --shell-completion=zsh)" |
There was a problem hiding this comment.
the command is actually cht:
| eval "$(cht-conf --shell-completion=zsh)" | |
| eval "$(cht --shell-completion=zsh)" |
| - `--skip-git-check` – Skip repository status check | ||
| - `--skip-translation-check` – Skip checking message translations | ||
| - `--skip-validate` – Skip form validation | ||
| - `--force` – Automatically answer yes to all prompts; overwrite changes |
There was a problem hiding this comment.
Can you give another pass on these to make them more helpful and more explicit? Think about why the user would want to use these flags? What scenarios might they be needed? What are the risks or benefits of using some of these?
for example:
`--accept-self-signed-certs` – Allow self-signed certificates
is just re-wording the flag and not adding any more information. Here's what I might do as an example (and feel free to use it verbatim so you get a freebie ;)
`--accept-self-signed-certs` – By default `cht` command will expect a valid TLS certificate on the CHT instance. However, sometimes there's an invalid self-signed certficate on a development instance. In this case, pass this flag so that `cht` will ignore any TLS errors when connecting to the CHT instance.
|
Thank you for the feedback! Working on it. |
|
Hi @arushi2702! Any updates on this PR? Did you manage to apply the feedback you received? |
3 participants
Description
This PR solves the first out of two tasks given in Issue #1968 . The content from cht-conf repo's README file that was initially missing from the documnetation site has been added.
License
The software is provided under AGPL-3.0. Contributions to this project are accepted under the same license.