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] Update README #925

Merged
merged 50 commits into from
Dec 12, 2024
Merged
Changes from 1 commit
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
40c94a6
delete old images
Joseph-Perkins Dec 10, 2024
1628e14
add new images
Joseph-Perkins Dec 10, 2024
8758fe7
update README
Joseph-Perkins Dec 10, 2024
c4b4a33
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 10, 2024
3cc536a
Ignore git folder for codespell
huong-li-nguyen Dec 11, 2024
70ee1c0
Simplify html code
huong-li-nguyen Dec 11, 2024
53a9c82
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
628f30a
Fix
huong-li-nguyen Dec 11, 2024
b157c05
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
5e9180e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
f28c724
Check if we can center image directly
huong-li-nguyen Dec 11, 2024
d7592f1
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
0bad920
Lint
huong-li-nguyen Dec 11, 2024
1929ac9
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
e1d1942
Check how it looks like
huong-li-nguyen Dec 11, 2024
fccfe8e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
7420898
Merge branch 'main' into docs/tidy-html-file
huong-li-nguyen Dec 11, 2024
4dfa9a3
Check if it looks terrible
huong-li-nguyen Dec 11, 2024
5a186e8
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
7017451
Check if it looks better
huong-li-nguyen Dec 11, 2024
2c28baf
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
3550633
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
ee436a6
Simplify layout
huong-li-nguyen Dec 11, 2024
a4e5624
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
dc65015
Lint
huong-li-nguyen Dec 11, 2024
4832b8a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
d4a1cd4
Simplify
huong-li-nguyen Dec 11, 2024
781334e
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
e027186
Merge branch 'main' into docs/README_wording_update
huong-li-nguyen Dec 11, 2024
7c80280
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
89f4dd2
Tidy
huong-li-nguyen Dec 11, 2024
66dba56
Merge branch 'docs/tidy-html-file' of https://github.com/mckinsey/viz…
huong-li-nguyen Dec 11, 2024
f0cc40b
Make images bigger
huong-li-nguyen Dec 11, 2024
93ab400
Merge branch 'docs/tidy-html-file' into docs/README_wording_update
huong-li-nguyen Dec 11, 2024
05ddb9a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
3e581c2
Copy over changes to general README
huong-li-nguyen Dec 11, 2024
14c1442
Merge branch 'docs/README_wording_update' of https://github.com/mckin…
huong-li-nguyen Dec 11, 2024
23d8486
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
9d1da8a
add break lines into the toolkit section, and apply minor tweaks to w…
Joseph-Perkins Dec 11, 2024
d7eae2c
make horizontal lines thinner
Joseph-Perkins Dec 11, 2024
dcbe14b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 11, 2024
e61d921
Sync changes and lint
huong-li-nguyen Dec 12, 2024
d4af3bc
Lint
huong-li-nguyen Dec 12, 2024
f305d0d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 12, 2024
2d4a4e9
Solve conflicts between linters
huong-li-nguyen Dec 12, 2024
3e056f8
Change header level
huong-li-nguyen Dec 12, 2024
598ea69
Remove hr
huong-li-nguyen Dec 12, 2024
4b49c87
Check how it looks like with previous header link
huong-li-nguyen Dec 12, 2024
3901b41
Bring over change
huong-li-nguyen Dec 12, 2024
61227ad
add links to toolkit images
Joseph-Perkins Dec 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Check if it looks better
huong-li-nguyen committed Dec 11, 2024
commit 7017451a4a370e2ce8f932d8a070bf6bfa79154d
25 changes: 13 additions & 12 deletions vizro-core/README.md
Original file line number Diff line number Diff line change
@@ -80,8 +80,9 @@ Use Vizro when you need to combine the speed and ease of low-code Python tools,

## How to use Vizro?

<img align="right" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_framework.svg" width="400">
<h3> <a href="https://vizro.readthedocs.io/en/stable/">Vizro framework</a> </h3>
### [Vizro framework](https://vizro.readthedocs.io/en/stable/)

<img align="right" width="300" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_framework.svg">

**Low-code framework for building dashboards.**

@@ -90,42 +91,42 @@ The Vizro framework underpins the entire Vizro toolkit. It is a Python package (
Visit the [documentation](https://vizro.readthedocs.io/en/stable/) for more details.

<br>
<br>

<img align="left" width="500" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_visual_vocabulary.png">
<h3> <a href="https://vizro-demo-visual-vocabulary.hf.space/">Visual vocabulary</a> </h3>

### [Visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/)

<img align="left" width="300" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_visual_vocabulary.png">

**Chart examples.**

The visual vocabulary helps you to decide which chart type to use for your requirements, and offers sample code to create these charts with Plotly or embed them into a Vizro dashboard.

Visit the [visual vocabulary](https://vizro-demo-visual-vocabulary.hf.space/) to search for charts or get inspiration.

<br>
<br>

<img align="right" width="500" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_dashboard_examples.png">
<h3> <a href="https://vizro.mckinsey.com/">Vizro examples gallery</a> </h3>
### [Vizro examples gallery](https://vizro.mckinsey.com/)

<img align="right" width="300" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_dashboard_examples.png">

**Dashboard examples.**

The dashboard examples gallery enables you to explore Vizro in action by viewing interactive example apps. You can copy the code to use as a template or starter for your next dashboard.

Visit the [dashboard examples gallery](https://vizro.mckinsey.com/) to see the dashboards in action.

<br>
<br>

<img align="left" width="500" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_vizro_ai.gif">
<h3> <a href="https://vizro.readthedocs.io/projects/vizro-ai/en/vizro-ai-0.3.2/">Vizro-AI</a> </h3>
### [Vizro-AI](https://vizro.readthedocs.io/projects/vizro-ai)

<img align="left" width="300" src="https://raw.githubusercontent.com/mckinsey/vizro/main/.github/images/toolkit_vizro_ai.gif">

**LLM generated charts and dashboards.**

Vizro-AI is a separate package (called `vizro_ai`) that extends Vizro to incorporate LLMs. Use it to build interactive Vizro charts and dashboards, by simply describing what you need in plain English or other languages.

Visit the [Vizro-AI documentation](https://vizro.readthedocs.io/projects/vizro-ai/) for more details.

<br>
<br>

## Installation and first steps