-
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: small improvements to "Set Configuration" how-to #197
Conversation
- add link to the referenced `Rag.chat()` function - remove new line after `!!! note` - otherwise most markdown editors will recognize the block as a code block due to the 4 space indentation - fix typo: "instesd" -> "instead" 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.
- remove new line after
!!! note
Commented the same on #196 as well: we need this newline or otherwise prettier
Lines 8 to 13 in c132661
- repo: https://github.com/pre-commit/mirrors-prettier | |
rev: v3.0.3 | |
hooks: | |
- id: prettier | |
types_or: | |
- markdown |
will merge the line below into the !!! note
directive.
https://github.com/Quansight/ragna/actions/runs/6835991151/job/18591268093?pr=197#step:6:31
And that will break the proper rendering
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
docs/how-tos/set-configuration.md
Outdated
@@ -59,4 +59,4 @@ config = Config.from_file(config_path) | |||
|
|||
!!! note | |||
|
|||
In the Python API, the `Rag.chat()` function also allows you to set certain RAG-specific configurations like `document` and `assistants`. | |||
In the Python API, the [`Rag.chat()` function](../references/python-api.md#ragna.core.Chat) also allows you to set certain RAG-specific configurations like `document` and `assistants`. |
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.
I think you can use they dynamic link here
In the Python API, the [`Rag.chat()` function](../references/python-api.md#ragna.core.Chat) also allows you to set certain RAG-specific configurations like `document` and `assistants`. | |
In the Python API, the [ragna.Rag.chat][] function also allows you to set certain RAG-specific configurations like `document` and `assistants`. |
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.
Renders and links correctly:
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.
TIL I've never seen that feature in mkdocs
👀
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.
This is not a feature of vanilla mkdocs
, but rather the mkdocstrings
plugin
Lines 45 to 56 in 4962665
- mkdocstrings: | |
default_handler: python | |
handlers: | |
python: | |
options: | |
show_source: false | |
show_root_heading: true | |
show_bases: false | |
unwrap_annotated: true | |
import: | |
- https://docs.python.org/3/objects.inv | |
- https://fastapi.tiangolo.com/objects.inv |
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 for the reference! I've primarily used mkdocs
for Argo Workflows and hadn't gotten too into the plugin ecosystem as we're looking to changed to RTD for versioned docs argoproj/argo-workflows#11390
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.
@agilgur5 I took the liberty to fix one comment I had to avoid another round of back and forth. See #197 (comment). Otherwise LGTM. Thanks!
Signed-off-by: Anton Gilgur <agilgur5@gmail.com> Co-authored-by: Philip Meier <github.pmeier@posteo.de>
Summary
Small docs improvements to "Set Configuration" page
Details
add link to the referenced
Rag.chat()
functionremove new line after!!! note
otherwise most markdown editors will recognize the block as a code block due to the 4 space indentation (same as docs: various improvements to Python API tutorial #196)prettier
per review comments, c.f. docs: small improvements to "Set Configuration" how-to #197 (review)fix typo: "instesd" -> "instead"