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

Add documentation about the demo example and clean up examples #379

Open
stichbury opened this issue Mar 20, 2024 · 0 comments
Open

Add documentation about the demo example and clean up examples #379

stichbury opened this issue Mar 20, 2024 · 0 comments
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 Mar 20, 2024

This is a good issue for someone interested in documentation. It doesn't require any particular knowledge of Vizro but does need an interest in poking through our examples folder in within vizro-core for this repo to see what is there and write about the layout and what the example shows. There's a basic style guide for docs creators here, but we are happy to take any contribution as we can run Vale over it to highlight any tweaks needed to follow the guidlines.

The examples folder in the repo holds the code for the demo.

It isn't very well highlighted in the docs and we need to do this:

  1. Add a section on the home page and a link to a page of text about the demo (mentioned in Restyle the documentation landing page #378 which will restyle that whole page)
  2. Add the page itself. That page should document the basics of the demo and how to work with it.
  3. Add a section in the examples folder where any contributions of example code for Create an example dashboard for novice/intermediate/advanced users #377 will be added.
@stichbury stichbury added Status: Help Wanted 🙏 Issue/PR needs extra attention Component: Docs 🗒️ Issue/PR for markdown and API documentation 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