-
Notifications
You must be signed in to change notification settings - Fork 22
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
docs: improvements to REST API tutorial #198
Conversation
- additions: - add link to REST API reference and Python API reference - stylistic improvements: - simplifications: - "For demonstration or exploration alone" -> "For demonstration purposes" - "make sure the username and password provided are identical" -> "make the username and password identical" - "as per your configuration" -> "based on your configuration" - "As per the demo configuration" -> "For the demo" - see also [k8s style guide on simple and direct language](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language) (which I use and reference often for docs -- it's a pretty great style guide!) - consistency: - "Large Language Model" -> "LLM" - almost everywhere else in the docs, including further up in this same doc, "LLM" is used as short-hand - "Large Language Model" can be explained in the first, intro doc, and then short-hand used everywhere after - "you can start" -> "you can now start" - "you can now" is used in other parts of this doc and is indicative of a sequence of steps - code style: - remove new line after `!!! tip` - otherwise most markdown editors will recognize the block as a code block due to the 4 space indentation - fix various spelling and grammar errors and typos: - "workflows starts" -> "workflows start" - "can select the components" -> "can select components" - the components are already described immediately after - "you terminal" -> "your terminal" - "a HTTP client" -> "an HTTP client" - "authentication into your user session" -> "authenticating your user session" - remove extra commas here as well - "you set" -> "set" - "And, use" -> "And use" - "(LLM)s" -> "(LLMs)" Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See #197 (review) for my inline comment. I'll let @pavithraes handle the rest.
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @agilgur5! Looks great, and again all suggestions are related to formatting (line length), we can merge after! 🌻
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @agilgur5 for the PR and @pavithraes for the review!
Summary
Several documentation improvements to the REST API tutorial
Basically the equivalent of #196 but for the REST API tutorial instead
Details
additions:
stylistic improvements:
remove new line after!!! tip
otherwise most markdown editors will recognize the block as a code block due to the 4 space indentationprettier
per review comments, c.f. docs: small improvements to "Set Configuration" how-to #197 (review)fix various spelling and grammar errors and typos: