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

Apply minor edits across core docs for enhanced readability #312

Open
stichbury opened this issue Feb 15, 2024 · 1 comment
Open

Apply minor edits across core docs for enhanced readability #312

stichbury opened this issue Feb 15, 2024 · 1 comment
Assignees
Labels
Component: Docs 🗒️ Issue/PR for markdown and API documentation Good first issue Good first issue for beginners Status: Help Wanted 🙏 Issue/PR needs extra attention

Comments

@stichbury
Copy link
Contributor

stichbury commented Feb 15, 2024

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:

  • Creating an informal "lexicon" or style guide (which could be added to the contribution guide)
  • Applying this across the docs
  • Creating a set of tickets if the readability review throws up a need to make further changes beyond minor word choices
@stichbury stichbury self-assigned this Feb 15, 2024
@stichbury stichbury added the Component: Docs 🗒️ Issue/PR for markdown and API documentation label Feb 15, 2024
@stichbury
Copy link
Contributor Author

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:

@stichbury stichbury added Status: Help Wanted 🙏 Issue/PR needs extra attention Good first issue Good first issue for beginners labels Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Docs 🗒️ Issue/PR for markdown and API documentation Good first issue Good first issue for beginners Status: Help Wanted 🙏 Issue/PR needs extra attention
Projects
None yet
Development

No branches or pull requests

1 participant