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.

Sign up for GitHub

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

Jump to bottom

Adding documentation for tabs and containers #206

Closed
wants to merge 3 commits into from
Closed

Adding documentation for tabs and containers #206

wants to merge 3 commits into from

Conversation

nadijagraca
Copy link
Contributor

@nadijagraca nadijagraca commented Dec 12, 2023 •
edited
Loading

Description

Documentation for tabs and containers.
To do:

  • update screenshots
  • add validations for tabs and containers

Checklist

  • I have not referenced individuals, products or companies in any commits, directly or indirectly
  • I have not added data or restricted code in any commits, directly or indirectly
  • I have updated the docstring of any public function/class/model changed
  • I have added tests to cover my changes (if applicable)

Types of changes

  • Docs/refactoring (non-breaking change which improves codebase)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Notice

  • I acknowledge and agree that, by checking this box and clicking "Submit Pull Request":

    • I submit this contribution under the Apache 2.0 license and represent that I am entitled to do so on behalf of myself, my employer, or relevant third parties, as applicable.
    • I certify that (a) this contribution is my original creation and / or (b) to the extent it is not my original creation, I am authorized to submit this contribution on behalf of the original creator(s) or their licensees.
    • I certify that the use of this contribution as authorized by the Apache 2.0 license does not violate the intellectual property rights of anyone else.

@nadijagraca
containers documentation
63ffdd5 
adding tabs documentation
@nadijagraca nadijagraca self-assigned this Dec 12, 2023
@nadijagraca nadijagraca added Status: Ready for Review ☑️ Docs 🗒️ Issue for markdown and API documentation labels Dec 12, 2023
maxschulz-COL
maxschulz-COL requested changes Dec 13, 2023
View reviewed changes
Copy link
Contributor

@maxschulz-COL maxschulz-COL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for writing all of this! Have some suggestions, let me know if anything is unclear

vizro-core/docs/pages/user_guides/containers.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/containers.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/containers.md
title: Container 2 title
title: Page Title
```
=== "Result"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The result doesn't render in a separate tab. I think the screenshot is still outdated right?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, the screenshots are not replaced yet. Example py and yaml are updated, but the screenshot image does not reflect the example code. Screenshots will be replaced when we fix tab title.

vizro-core/docs/pages/user_guides/containers.md Show resolved Hide resolved
vizro-core/docs/pages/user_guides/containers.md Outdated
To create and add a container to your page, do the following steps:

1. Provide a `title` to your [`Container`][vizro.models.Container]
2. Configure your `components`, see our guide on [Charts/Components](components.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you may have compied this from another guide? This is a little outdated, as the guides and graph, table and cards&buttons are now separate.

Could we change this to say "see our guides on the various options here (e.g. Graphs, Tables, Cards & Buttons)."

If this was copied somewhere else, can we change it there too

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I've copied this from pages.md - repaced it with suggested now.

vizro-core/docs/pages/user_guides/tabs.md Outdated Show resolved Hide resolved
vizro-core/src/vizro/models/_components/container.py Show resolved Hide resolved
vizro-core/src/vizro/models/_components/container.py Outdated Show resolved Hide resolved
vizro-core/src/vizro/models/_components/container.py Show resolved Hide resolved
vizro-core/src/vizro/models/_components/tabs.py Outdated Show resolved Hide resolved
@huong-li-nguyen huong-li-nguyen marked this pull request as draft December 19, 2023 22:20
@huong-li-nguyen huong-li-nguyen mentioned this pull request Jan 10, 2024
Merged
1 task
@huong-li-nguyen
Copy link
Contributor

Closing for new PR on this: #262

@huong-li-nguyen huong-li-nguyen deleted the docs/tabs_containers branch April 12, 2024 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maxschulz-COL maxschulz-COL maxschulz-COL requested changes

@Joseph-Perkins Joseph-Perkins Awaiting requested review from Joseph-Perkins

@antonymilne antonymilne Awaiting requested review from antonymilne

@huong-li-nguyen huong-li-nguyen Awaiting requested review from huong-li-nguyen

@lingyielia lingyielia Awaiting requested review from lingyielia

Assignees

@nadijagraca nadijagraca

Labels
Docs 🗒️ Issue for markdown and API documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@nadijagraca @huong-li-nguyen @maxschulz-COL