mckinsey / vizro

Vizro is a toolkit for creating modular data visualization applications.
https://vizro.readthedocs.io/en/stable/
Apache License 2.0
2.49k stars 112 forks source link

Apply minor edits across core docs for enhanced readability #312

Open stichbury opened 5 months ago

stichbury commented 5 months ago

This is a good issue for anyone interested in docs to the point of applying a style guide to some markdown. There's no rewriting required (just small tweaks) and no knowledge of Vizro is expected.

I think the core docs (and probably vizro-ai docs too) could benefit from a minor edit to improve their readability. This would involve the following steps:

stichbury commented 4 months ago

Style guide is now added to the contribution guide. I've applied it to the Get Started docs and it would be awesome to see it applied to other pages. I will get round to it all in time, but am putting a "Help Wanted" and "Good First Issue" label on this because we could definitely use outside help. For example: