Skip to content

Apply minor edits across core docs for enhanced readabilityΒ #312

Closed
@stichbury

Description

@stichbury

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Docs πŸ—’οΈIssue for markdown and API documentationGood first issue 🐀Issue suitable for first-time contributorsHelp Wanted πŸ™Issue needs extra attentionhacktoberfestA month-long celebration of all things open-source

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions