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

Adjusting User guide structure #42

Merged
merged 18 commits into from
Sep 21, 2023
Merged

Adjusting User guide structure #42

merged 18 commits into from
Sep 21, 2023

Conversation

maxschulz-COL
Copy link
Contributor

@maxschulz-COL maxschulz-COL commented Sep 18, 2023

Description

  • change the structure of user-guide to be more topic focussed
  • add link to github at the top right
  • introduce last-changed footnote

Screenshot

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 the PR number to the change description in the changelog fragment, e.g. Enable feature XXX ([#1](https://github.com/mckinsey/vizro/pull/1)) (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)

@@ -9,7 +9,7 @@ The [`Dashboard`][vizro.models.Dashboard] model accepts the `pages` argument, wh

A [`Page`][vizro.models.Page] is split up into three main containers:

1. The **control container** where you can add your [Controls](control.md) to interact with the dashboard
1. The **control container** where you can add your `controls` (see e.g. [Filters](filters.md) or [Parameters](parameters.md)) to interact with the dashboard
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@nadijagraca I think this needs to be updated as we now have dedicated navigation right?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, this needs to be updated to reflect the fact we have a navigation container now as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could you add this to your PR on the images?

chiara-sophie
chiara-sophie previously approved these changes Sep 18, 2023
Copy link
Contributor

@chiara-sophie chiara-sophie left a comment

Choose a reason for hiding this comment

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

Good to go! Small coments for consitency 👍

vizro-core/mkdocs.yml Show resolved Hide resolved
vizro-core/docs/pages/tutorials/explore_components.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/tutorials/explore_components.md Outdated Show resolved Hide resolved
@maxschulz-COL maxschulz-COL added Status: Ready for Review ☑️ Issue/PR is ready for review - all tests have passed Docs 🗒️ Issue/PR for markdown and API documentation labels Sep 18, 2023
nadijagraca
nadijagraca previously approved these changes Sep 20, 2023
Copy link
Contributor

@nadijagraca nadijagraca left a comment

Choose a reason for hiding this comment

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

Looks good to me. 🚀

chiara-sophie
chiara-sophie previously approved these changes Sep 20, 2023
Copy link
Contributor

@chiara-sophie chiara-sophie left a comment

Choose a reason for hiding this comment

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

Looks good to me! 👍 I just made some suggestions on the docs, but feel free to disregard them

vizro-core/docs/pages/tutorials/explore_components.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/filters.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/filters.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/filters.md Show resolved Hide resolved
vizro-core/docs/pages/user_guides/parameters.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/parameters.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/parameters.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/selectors.md Outdated Show resolved Hide resolved
vizro-core/docs/pages/user_guides/selectors.md Outdated Show resolved Hide resolved
Co-authored-by: Chiara Pullem <94166847+chiara-sophie@users.noreply.github.com>
Co-authored-by: Chiara Pullem <94166847+chiara-sophie@users.noreply.github.com>
maxschulz-COL and others added 6 commits September 20, 2023 14:27
Co-authored-by: Chiara Pullem <94166847+chiara-sophie@users.noreply.github.com>
Co-authored-by: Chiara Pullem <94166847+chiara-sophie@users.noreply.github.com>
Copy link
Contributor

@nadijagraca nadijagraca left a comment

Choose a reason for hiding this comment

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

LGTM!

@maxschulz-COL maxschulz-COL changed the title Docs feedback PR Adjusting User guide structure Sep 20, 2023
Copy link
Contributor

@chiara-sophie chiara-sophie left a comment

Choose a reason for hiding this comment

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

Good to go 👍

@maxschulz-COL maxschulz-COL merged commit 87bcbc1 into main Sep 21, 2023
19 checks passed
@maxschulz-COL maxschulz-COL deleted the docs/navigation branch September 21, 2023 07:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs 🗒️ Issue/PR for markdown and API documentation Status: Ready for Review ☑️ Issue/PR is ready for review - all tests have passed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants