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

Review docs for lists and ensure they are bullets/numbers according to the information they present #514

Closed
stichbury opened this issue Jun 4, 2024 · 3 comments
Assignees
Labels
Docs 🗒️ Issue for markdown and API documentation Good first issue 🐤 Issue suitable for first-time contributors hacktoberfest A month-long celebration of all things open-source Help Wanted 🙏 Issue needs extra attention

Comments

@stichbury
Copy link
Contributor

This is issue #965 on the internal repo. It's perfect for an external contributor and they don't need any major awareness of Vizro.

Docs change is needed where bullets are used in docs and present a sequence of actions -- this should be a numbered list.
Likewise, if a numbered list is used, it should be because the items need to be done in that particular sequence.

The task is to review each page of the core and vizro-ai docs and check where bullets are used to confirm they're correctly formatted. There may be some lists that we don't need (and it may sometimes make sense to add them, but that's an extension task).

Reference to -> #482 (comment)

@stichbury stichbury added Help Wanted 🙏 Issue needs extra attention Docs 🗒️ Issue for markdown and API documentation labels Jun 4, 2024
@huong-li-nguyen huong-li-nguyen added the Good first issue 🐤 Issue suitable for first-time contributors label Jul 10, 2024
@antonymilne antonymilne added hacktoberfest A month-long celebration of all things open-source and removed GHC: docs/code track labels Oct 9, 2024
@Dljdd
Copy link
Contributor

Dljdd commented Oct 14, 2024

Hi I can help with this

@antonymilne
Copy link
Contributor

Hi @Dljdd, thank you for your offer to help! I've assigned you the issue so please do go ahead with it. You'll want to take a look at our contribution guide first, and then if you need any help then just give us a shout.

@Dljdd Dljdd mentioned this issue Oct 30, 2024
@stichbury
Copy link
Contributor Author

Closed by PR #844 thanks to @Dljdd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 🗒️ Issue for markdown and API documentation Good first issue 🐤 Issue suitable for first-time contributors hacktoberfest A month-long celebration of all things open-source Help Wanted 🙏 Issue needs extra attention
Projects
None yet
Development

No branches or pull requests

4 participants