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] Remove examples section and point through to gallery #814

Merged
merged 12 commits into from
Oct 22, 2024
Merged
2 changes: 1 addition & 1 deletion vizro-core/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Vizro is a toolkit for creating modular data visualization applications.
---

[:octicons-arrow-right-24: Tutorials](pages/tutorials/explore-components.md) <br/>
[:octicons-arrow-right-24: Examples](pages/examples/examples.md)
[:octicons-arrow-right-24: Examples](https://vizro.mckinsey.com)



Expand Down
29 changes: 0 additions & 29 deletions vizro-core/docs/pages/examples/examples.md

This file was deleted.

12 changes: 11 additions & 1 deletion vizro-core/docs/pages/explanation/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,17 @@ We do not consider frontend changes (such as changing the appearance of a compon

## Where can I find example dashboards?

Check out our [examples section](../examples/examples.md) which describes the contents of the `examples` folder of the [Vizro GitHub repository](https://github.com/mckinsey/vizro/tree/main/vizro-core/examples).
For a gallery of examples of Vizro in action, take a look at [vizro.mckinsey.com](https://vizro.mckinsey.com).

Within Vizro's GitHub repository, the [`examples/dev` folder](https://github.com/mckinsey/vizro/tree/main/vizro-core/examples/dev) of `vizro-core` contains example code using the pydantic model. If you have any problems running the example code, please [raise an issue](https://github.com/mckinsey/vizro/issues) on the Vizro repository.

!!! note

The pydantic model should be your preferred method of dashboard configuration, but you can also [define a dashboard with YAML, JSON, or as a Python dictionary](../user-guides/dashboard.md). To guide you, the `examples/dev` folder also contains an alternative `yaml_version` of the gapminder example, which offers the same example as the pydantic model but via YAML configuration.

### Examples from Vizro users

We maintain a separate, curated page of [videos, blog posts, and examples of Vizro usage from our community](your-examples.md).
stichbury marked this conversation as resolved.
Show resolved Hide resolved

## Why should I use Vizro?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ If you have something you'd like us to include on the list, or spot something th
* [Build Python Data Apps with Vizro Dash](https://www.youtube.com/watch?v=wmQ6_GZ0zSk).
* [Introduction to Vizro Actions - Plotly Dash](https://www.youtube.com/watch?v=bom-9275Cic&t=8s).
* [Use Dash AG Grid within a Vizro app](https://www.youtube.com/watch?v=YvtVcXwQw0E).
* [Visual Vocabulary Dashboard with Vizro Plotly](https://www.youtube.com/watch?v=OZNAokBKT-M)
stichbury marked this conversation as resolved.
Show resolved Hide resolved

## Blog posts
* [Introducing Vizro](https://quantumblack.medium.com/introducing-vizro-a-toolkit-for-creating-modular-data-visualization-applications-3a42f2bec4db).
Expand Down
4 changes: 2 additions & 2 deletions vizro-core/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ nav:
- Figure functions: pages/API-reference/figure-callables.md
- Explanation:
- FAQs: pages/explanation/faq.md
- User examples: pages/explanation/your-examples.md
- Contribute to Vizro: pages/explanation/contributing.md
- Documentation style: pages/explanation/documentation-style-guide.md
- Authors: pages/explanation/authors.md
- Examples:
- Example dashboard code: pages/examples/examples.md
- Examples from Vizro users: pages/examples/your-examples.md
- Vizro gallery: https://vizro.mckinsey.com/
- Vizro-AI:
- Vizro-AI: https://vizro.readthedocs.io/projects/vizro-ai/

Expand Down
Loading