-
Notifications
You must be signed in to change notification settings - Fork 144
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
Conversation
Signed-off-by: Jo Stichbury <[email protected]>
Signed-off-by: Jo Stichbury <[email protected]>
…ey/vizro into docs/revise-vizro-ai-docs
Signed-off-by: Jo Stichbury <[email protected]>
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
…ey/vizro into docs/revise-vizro-ai-docs
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.
Really good job Jo. I love the new docs. 🚀
I am being a pain, I cannot approve this as you didn't click the button 😂 @Joseph-Perkins |
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.
LGTM in general 👍 Have a few comments and question!
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.
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 🤔 ?
Co-authored-by: Li Nguyen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
Co-authored-by: Li Nguyen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
Co-authored-by: Li Nguyen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
Co-authored-by: Li Nguyen <[email protected]> Signed-off-by: Jo Stichbury <[email protected]>
…ey/vizro into docs/revise-vizro-ai-docs
…ey/vizro into docs/revise-vizro-ai-docs
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.
🚀
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 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!
I've made the changes as requested
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":