[Docs] Restructure of Vizro-AI dashboard docs

[nadijagraca]

Description

• scrap the entire Examples section for a tab that says: Try out! (this would lead to vizro.mckinsey.com)

• add the chart examples under Advanced charts (basically as a kind of user guide), each chart in its own category

• combine Generate a complex dashboard and Retrieve code for a generated dashboard into a new Run vizro_ai.dashboard to match exactly what we have for charts, significantly reducing the repeat on the code generation page, which always annoyed me (this would make the two sections align), ideally using a very! simple dashboard prompt

• Add the more complex dashboard examples under a new page that mimics the Generate a complex dashboard one

• remove the component table on the home page (the one that says whats possible) and add it in the new Run vizro-ai.dashboard, where it really belongs

• (bonus) Add a similarly awesome gif to the chart creation one for the dashboard creation on both the homepage and the README - will be added in another PR

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.

[github-actions]

View the example dashboards of the current commit live on PyCafe ☕ 🚀

Updated on: 2024-11-21 12:23:44 UTC
Commit: 6d6ec62

Link: vizro-core/examples/dev/

Link: vizro-core/examples/scratch_dev

Link: vizro-core/examples/visual-vocabulary/

Link: vizro-ai/examples/dashboard_ui/

[maxschulz-COL]

Didn't read in last detail, will leave that to @stichbury, but this is I think a great improvement

[stichbury]

LGTM! Just a few suggestions. Please can you also run Vale over the text (introduce a deliberate error to trigger it to give you all the warnings/suggestions too) so that you catch any typos and use of words like "provide" that I have missed. No need to fix anything in Vizro-Core but if you find any in Vizro-AI please can you address them?

[nadijagraca]

LGTM! Just a few suggestions. Please can you also run Vale over the text (introduce a deliberate error to trigger it to give you all the warnings/suggestions too) so that you catch any typos and use of words like "provide" that I have missed. No need to fix anything in Vizro-Core but if you find any in Vizro-AI please can you address them?

I have trouble running vale, I get the exact error you posted on vizro-dev channel few weeks ago. For now, I'm relying on CI to lint.

[stichbury]

I have trouble running vale, I get the exact error you posted on vizro-dev channel few weeks ago. For now, I'm relying on CI to lint.

I'll make a commit that "breaks" it and we'll see what Vale suggestions/warnings come up.