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]fix vizro ai doc links #492

Merged
merged 5 commits into from
May 23, 2024
Merged

[Docs]fix vizro ai doc links #492

merged 5 commits into from
May 23, 2024

Conversation

Anna-Xiong
Copy link
Contributor

@Anna-Xiong Anna-Xiong commented May 22, 2024

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

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.
    • I have not referenced individuals, products or companies in any commits, directly or indirectly.
    • I have not added data or restricted code in any commits, directly or indirectly.

@Anna-Xiong
Copy link
Contributor Author

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

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.

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

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

Thank you 🌟

@Anna-Xiong Anna-Xiong merged commit ebc0f39 into main May 23, 2024
34 of 39 checks passed
@Anna-Xiong Anna-Xiong deleted the docs/vizro_ai_faq_links branch May 23, 2024 13:24
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.

None yet

3 participants