[Docs] Update README

[Joseph-Perkins]

Description

The wording and some images on the README will be updated in this PR

Preview: https://github.com/mckinsey/vizro/blob/docs/README_wording_update/vizro-core/README.md

Screenshot

N/A

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-12-12 10:13:49 UTC
Commit: 61227ad

Link: vizro-core/examples/dev/

Link: vizro-core/examples/scratch_dev

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

Link: vizro-ai/examples/dashboard_ui/

[huong-li-nguyen]

@Joseph-Perkins - I've had to change the formatting a bit, as otherwise the linters couldn't deal with it. Basically the hack of using ## to create a thinner horizontal lines leads to conflicts between two linters, which can't be solved without having to ignore one. Ignoring any of these is not optimal, as we can't ignore per-line.

Remember that this README also renders on pypi, so the "hack" that looked fine on Github didn't look so nicely on pypi, so I decided to remove the horizontal rulers entirely to keep the file clean and moved the headers a level up. I think that looks good still and keeps the md file tidy 👍

[huong-li-nguyen]

@stichbury - could you take a final look? It's the same PR from the internal version :)

[stichbury]

This looks great to me. There's a couple of minor issues with the infographic (a missing Oxford comma 😱 and maybe an extra space or two in places) but I think we should live with it for now.