Skip to content
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.

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

show command reply docs #185

Open
zuiderkwast opened this issue Dec 24, 2024 · 0 comments · May be fixed by #183
Open

show command reply docs #185

zuiderkwast opened this issue Dec 24, 2024 · 0 comments · May be fixed by #183
Labels
enhancement New feature or request

Comments

@zuiderkwast
Copy link
Contributor

An important part of a command is what it returns back to the client. This part of the docs is missing in the website.

It's in the replies json files in the doc repo, which contain markdown text wrapped in json array per command. This info doesn't exist anywhere else.

For reference, the way this is used for the man pages:

  • Yhe strings are concatenated with double linebreaks to turn each string into a separate paragraph or bullet.
  • If the content for RESP2 and RESP3 is identical, it is only displayed once.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant