mckinsey / vizro

Vizro is a toolkit for creating modular data visualization applications.
https://vizro.readthedocs.io/en/stable/
Apache License 2.0
2.46k stars 109 forks source link

[Docs]fix vizro ai doc links #492

Closed Anna-Xiong closed 1 month ago

Anna-Xiong commented 1 month ago

Description

fix links missing in docs:

INFO    -  Doc file 'pages/explanation/disclaimer.md' contains a link './faq.md#which-llms-are-supported-by-vizro-ai', but the doc 'pages/explanation/faq.md' does not contain an anchor '#which-llms-are-supported-by-vizro-ai'.
INFO    -  Doc file 'pages/user-guides/run-vizro-ai.md' contains a link '../user-guides/install.md#large-language-model', but the doc 'pages/user-guides/install.md' does not contain an anchor '#large-language-model'.

Screenshot

Notice

Anna-Xiong commented 1 month ago

Hi @stichbury , I raised this pr to fix the issues quickly the doc link missing.

I added the supported model in FAQ, but we could also change it to user-guides/customize-vizro-ai.md/#supported-models

Let me know if this makes sense or if there are more alteration we need here. Thank you!

stichbury commented 1 month ago

I added the supported model in FAQ, but we could also change it to user-guides/customize-vizro-ai.md/#supported-models

I think we should change it rather than add it again. You could keep the question in the FAQ and add a link to the user-guides page there too, so everything links to one page for maintenance simplicity.