diff --git a/.github/images/Vizro_Github_Banner_Dark_Mode.png b/.github/images/Vizro_Github_Banner_Dark_Mode.png
new file mode 100644
index 000000000..afcd0809b
Binary files /dev/null and b/.github/images/Vizro_Github_Banner_Dark_Mode.png differ
diff --git a/.github/images/Vizro_Github_Banner_Light_Mode.png b/.github/images/Vizro_Github_Banner_Light_Mode.png
new file mode 100644
index 000000000..767d67712
Binary files /dev/null and b/.github/images/Vizro_Github_Banner_Light_Mode.png differ
diff --git a/.github/images/code_dashboard.png b/.github/images/code_dashboard.png
new file mode 100644
index 000000000..ab35c6514
Binary files /dev/null and b/.github/images/code_dashboard.png differ
diff --git a/.github/images/dashboard_examples.png b/.github/images/dashboard_examples.png
new file mode 100644
index 000000000..70922f659
Binary files /dev/null and b/.github/images/dashboard_examples.png differ
diff --git a/.github/images/example_screens.png b/.github/images/example_screens.png
new file mode 100644
index 000000000..d35209b8d
Binary files /dev/null and b/.github/images/example_screens.png differ
diff --git a/.github/images/live_interactive_demo.png b/.github/images/live_interactive_demo.png
new file mode 100644
index 000000000..a03ac9c7b
Binary files /dev/null and b/.github/images/live_interactive_demo.png differ
diff --git a/.github/images/tech_logos.png b/.github/images/tech_logos.png
new file mode 100644
index 000000000..aebb0cc2d
Binary files /dev/null and b/.github/images/tech_logos.png differ
diff --git a/.github/images/value_prop_icons.png b/.github/images/value_prop_icons.png
new file mode 100644
index 000000000..3636d3c8d
Binary files /dev/null and b/.github/images/value_prop_icons.png differ
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644
index 000000000..c61b66391
--- /dev/null
+++ b/LICENSE.md
@@ -0,0 +1,201 @@
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
diff --git a/README.md b/README.md
index 7d0b67831..e83e6e7da 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,125 @@
-# Vizro
+
+
-[]()
-[]()
+
+[](https://pypi.org/project/vizro/)
+[](https://github.com/mckinsey/vizro/blob/main/LICENSE.md)
+
+
+
+
+
+---
+
+
+
+
+
+
+
+
+Visual Intelligence. Beautifully engineered
+
+
+
+
+
+
Vizro is a toolkit for creating modular data visualization applications
+
+
+
+
+
+
+
+## What is Vizro?
+
+
+
+Rapidly self-serve the assembly of customised dashboards in minutes - without the need for advanced coding or design experience - to create flexible and scalable, Python enabled data visualization applications
+
+
+
+
+
+
+
+Use a few lines of simple configuration to create complex dashboards, which are automatically assembled utilising libraries such as **Plotly** and **Dash**, with inbuilt coding and design best practices
+
+Define high level categories within the configuration, including:
+
+- **components:** create charts, tables, input/output interfaces, and more
+- **controls**: create filters, parameter inputs, and custom action controllers
+- **pages, layouts and navigation**: create multiple pages, with customisable layouts and flexible navigation across them
+- **actions and interactions**: create interactions between charts, and use pre-defined or customised actions (such as exporting)
+
+Configuration can be written in multiple formats including **Pydantic models**, **JSON**, **YAML** or **Python dictionaries** for added flexibility of implementation
+
+Optional high-code extensions allow almost infinite customisation in a modular way, combining the best of low-code and high-code - for flexible and scalable, Python enabled data visualization applications
+
+
+
+### Key benefits
+
+
+
+
+
+
+
+
+
+### Examples
+
+
+
+
+
+### Live demo
+
+
+
+
+
+
+## Installation
+
+```console
+pip install vizro
+```
+
+See the [Install guide](https://vizro.readthedocs.io/en/latest/pages/user_guides/install/) for more information
+
+Please note this repository is a monorepo and the core `vizro` package can be found in [/vizro-core](https://github.com/mckinsey/vizro/tree/main/vizro-core)
+
+## Getting started
+
+See the [Tutorials](https://vizro.readthedocs.io/en/latest/pages/tutorials/first_dashboard/) for creating your first dashboard
## Documentation
-See the [`docs`](https://vizro.readthedocs.io/en/latest/) for more details
+See the [Documentation](https://vizro.readthedocs.io/en/latest/) for more details
+
+---
+
+## Community and Development
+
+We encourage you to ask and answer technical questions via the [GitHub Issues](https://github.com/mckinsey/vizro/issues)
+
+## Contributing
-## Contributors
+To learn more about making a contribution,
+please see the [Contributing Guide](https://vizro.readthedocs.io/en/latest/pages/development/contributing/) for more information
-See the [authors](https://github.com/mckinsey/vizro/blob/main/vizro-core/docs/pages/development/authors.md) file for more details
+You can also view current and former [contributors](https://vizro.readthedocs.io/en/latest/pages/development/authors/)
## License
diff --git a/vizro-core/README.md b/vizro-core/README.md
index 7d0b67831..e83e6e7da 100644
--- a/vizro-core/README.md
+++ b/vizro-core/README.md
@@ -1,17 +1,125 @@
-# Vizro
+
+
-[]()
-[]()
+
+[](https://pypi.org/project/vizro/)
+[](https://github.com/mckinsey/vizro/blob/main/LICENSE.md)
+
+
+
+
+
+---
+
+
+
+
+
+
+
+
+Visual Intelligence. Beautifully engineered
+
+
+
+
+
+
Vizro is a toolkit for creating modular data visualization applications
+
+
+
+
+
+
+
+## What is Vizro?
+
+
+
+Rapidly self-serve the assembly of customised dashboards in minutes - without the need for advanced coding or design experience - to create flexible and scalable, Python enabled data visualization applications
+
+
+
+
+
+
+
+Use a few lines of simple configuration to create complex dashboards, which are automatically assembled utilising libraries such as **Plotly** and **Dash**, with inbuilt coding and design best practices
+
+Define high level categories within the configuration, including:
+
+- **components:** create charts, tables, input/output interfaces, and more
+- **controls**: create filters, parameter inputs, and custom action controllers
+- **pages, layouts and navigation**: create multiple pages, with customisable layouts and flexible navigation across them
+- **actions and interactions**: create interactions between charts, and use pre-defined or customised actions (such as exporting)
+
+Configuration can be written in multiple formats including **Pydantic models**, **JSON**, **YAML** or **Python dictionaries** for added flexibility of implementation
+
+Optional high-code extensions allow almost infinite customisation in a modular way, combining the best of low-code and high-code - for flexible and scalable, Python enabled data visualization applications
+
+
+
+### Key benefits
+
+
+
+
+
+
+
+
+
+### Examples
+
+
+
+
+
+### Live demo
+
+
+
+
+
+
+## Installation
+
+```console
+pip install vizro
+```
+
+See the [Install guide](https://vizro.readthedocs.io/en/latest/pages/user_guides/install/) for more information
+
+Please note this repository is a monorepo and the core `vizro` package can be found in [/vizro-core](https://github.com/mckinsey/vizro/tree/main/vizro-core)
+
+## Getting started
+
+See the [Tutorials](https://vizro.readthedocs.io/en/latest/pages/tutorials/first_dashboard/) for creating your first dashboard
## Documentation
-See the [`docs`](https://vizro.readthedocs.io/en/latest/) for more details
+See the [Documentation](https://vizro.readthedocs.io/en/latest/) for more details
+
+---
+
+## Community and Development
+
+We encourage you to ask and answer technical questions via the [GitHub Issues](https://github.com/mckinsey/vizro/issues)
+
+## Contributing
-## Contributors
+To learn more about making a contribution,
+please see the [Contributing Guide](https://vizro.readthedocs.io/en/latest/pages/development/contributing/) for more information
-See the [authors](https://github.com/mckinsey/vizro/blob/main/vizro-core/docs/pages/development/authors.md) file for more details
+You can also view current and former [contributors](https://vizro.readthedocs.io/en/latest/pages/development/authors/)
## License
diff --git a/vizro-core/changelog.d/20230920_215824_maximilian_schulz_proper_README.md b/vizro-core/changelog.d/20230920_215824_maximilian_schulz_proper_README.md
new file mode 100644
index 000000000..d57e34cc2
--- /dev/null
+++ b/vizro-core/changelog.d/20230920_215824_maximilian_schulz_proper_README.md
@@ -0,0 +1,42 @@
+
+
+
+
+
+
+
+
diff --git a/vizro-core/docs/pages/user_guides/filters.md b/vizro-core/docs/pages/user_guides/filters.md
index 4707a5e74..b66be30d8 100644
--- a/vizro-core/docs/pages/user_guides/filters.md
+++ b/vizro-core/docs/pages/user_guides/filters.md
@@ -3,7 +3,7 @@
This guide shows you how to add filters to your dashboard. One main way to interact with the charts/components on your page is by filtering the underlying data. A filter selects a subset of rows of a component's underlying DataFrame which alters the appearance of that component on the page.
The [`Page`][vizro.models.Page] model accepts the `controls` argument, where you can enter a [`Filter`][vizro.models.Filter] model.
-These models allow the automatic creation of selectors (e.g. Dropdown, RadioItems, Slider, ...) that let a dashboard user interact with the charts/components on the screen.
+This model allows the automatic creation of selectors (e.g. Dropdown, RadioItems, Slider, ...) that let a dashboard user filter with the charts/components on the screen.
## Basic Filters
@@ -41,7 +41,7 @@ automatically based on the target column, e.g. a dropdown for categorical data o
```
=== "app.yaml"
```yaml
- # Still requires a .py to register data connector in Data Manager and parse yaml configuration - see from_yaml example
+ # Still requires a .py to register data connector in Data Manager and parse yaml configuration
# See from_yaml example
pages:
- components:
diff --git a/vizro-core/mkdocs.yml b/vizro-core/mkdocs.yml
index 05aef24f4..4bf312f4d 100644
--- a/vizro-core/mkdocs.yml
+++ b/vizro-core/mkdocs.yml
@@ -8,15 +8,15 @@ nav:
- User Guides:
- Fundamentals:
- Install: pages/user_guides/install.md
- - Pages: pages/user_guides/pages.md
- Dashboards: pages/user_guides/dashboard.md
+ - Pages: pages/user_guides/pages.md
- Run Methods: pages/user_guides/run.md
+ - Components:
+ - Charts, Cards, Buttons: pages/user_guides/components.md
- Controls:
- Filters: pages/user_guides/filters.md
- Parameters: pages/user_guides/parameters.md
- Selectors: pages/user_guides/selectors.md
- - Components:
- - Charts, Cards, Buttons: pages/user_guides/components.md
- Navigation:
- Accordion: pages/user_guides/navigation.md
- Visual Formatting: