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

docs: small improvements to "Set Configuration" how-to #197

Merged
merged 4 commits into from
Nov 13, 2023

Conversation

agilgur5
Copy link
Contributor

@agilgur5 agilgur5 commented Nov 11, 2023

Summary

Small docs improvements to "Set Configuration" page

Details

- 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>
Copy link
Member

@pmeier pmeier left a 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

- 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

image

docs/how-tos/set-configuration.md Outdated Show resolved Hide resolved
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 requested a review from pmeier November 12, 2023 19:49
@@ -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`.
Copy link
Member

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

Suggested change
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`.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

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 👀

Copy link
Member

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

ragna/mkdocs.yml

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

Copy link
Contributor Author

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

Copy link
Member

@pmeier pmeier left a 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!

@pmeier pmeier merged commit dbacc8d into Quansight:main Nov 13, 2023
4 checks passed
@agilgur5 agilgur5 deleted the docs-improve-config branch November 13, 2023 14:59
pmeier added a commit that referenced this pull request Nov 30, 2023
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Co-authored-by: Philip Meier <github.pmeier@posteo.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants