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] Revise Vizro-AI docs to align with style guide #381

Merged
merged 25 commits into from
Mar 26, 2024

Conversation

stichbury
Copy link
Contributor

@stichbury stichbury commented Mar 21, 2024

Description

Now ready for review. You can see the built docs here: https://vizro--381.org.readthedocs.build/projects/vizro-ai/en/381/

I have made changes that should be familiar given the set I've made on vizro-core to follow the style guide. For example, I've change capitalisation in headers to sentence case.

I also rationalised the installation guide to align it more closely to the one for vizro-core and I converted a page to FAQs since it was better titled to answer common queries. The LLM API key content moves into the installation guide since, for now at least, it's covering just OpenAI and doesn't need to keep redirecting the reader around the docs to different places. I think getting the .env file set up is probably the most confusing thing for novice users who are unfamiliar with API keys and environment settings...we need to think about about a video at some point.

I moved some text around on the index page to remove the most "promotional" copy (that can go into the README if we need it) and keep it short and useful. The box navigation is now above the fold.

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.

@stichbury stichbury added the Docs 🗒️ Issue for markdown and API documentation label Mar 21, 2024
@stichbury stichbury self-assigned this Mar 21, 2024
Copy link
Contributor

@nadijagraca nadijagraca left a comment

Choose a reason for hiding this comment

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

Really good job Jo. I love the new docs. 🚀

@maxschulz-COL
Copy link
Contributor

I am being a pain, I cannot approve this as you didn't click the button 😂 @Joseph-Perkins

Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

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

LGTM in general 👍 Have a few comments and question!

vizro-ai/docs/index.md Outdated Show resolved Hide resolved
vizro-ai/docs/index.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/explanation/safety-in-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/explore-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/explore-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/explore-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/explore-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/quickstart.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/user-guides/install.md Outdated Show resolved Hide resolved
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

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

Hey Jo, I think we can still work a little bit on shuffling the sections. I think also some of the pages have gotten lost 🤔 ?

vizro-ai/mkdocs.yml Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/quickstart.md Outdated Show resolved Hide resolved
vizro-ai/docs/pages/tutorials/explore-vizro-ai.md Outdated Show resolved Hide resolved
vizro-ai/mkdocs.yml Show resolved Hide resolved
stichbury and others added 2 commits March 26, 2024 09:57
Copy link
Contributor

@huong-li-nguyen huong-li-nguyen left a comment

Choose a reason for hiding this comment

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

🚀

Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

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

I think we have a duplicated section, but after that I think we are good to go! Really good overhaul, and it is already much more concise 💪

One last idea: shall we move the FAQs to the Explanation section, then I think we are super clean and following the diataxis framework well!

vizro-ai/docs/pages/user-guides/use-different-languages.md Outdated Show resolved Hide resolved
@stichbury stichbury requested a review from maxschulz-COL March 26, 2024 17:02
@stichbury stichbury enabled auto-merge (squash) March 26, 2024 17:10
@stichbury stichbury dismissed maxschulz-COL’s stale review March 26, 2024 17:14

I've made the changes as requested

@stichbury stichbury merged commit bcfa0d1 into main Mar 26, 2024
34 checks passed
@stichbury stichbury deleted the docs/revise-vizro-ai-docs branch March 26, 2024 17:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 🗒️ Issue for markdown and API documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants