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 a tabbed navigation to move between vizro-core and vizro-ai docs #390

Open
stichbury opened this issue Mar 26, 2024 · 1 comment
Open
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

The Kedro docs (https://docs.kedro.org) has a tabbed navigation.

image

Why can't we have something similar? This shouldn't be a major piece of work and will simply enable users to move between https://vizro.readthedocs.io/en/stable/ and https://vizro.readthedocs.io/projects/vizro-ai/en/latest/ at a top level.

We did this in Kedro in the layout.html https://github.com/kedro-org/kedro/blob/main/docs/source/_templates/layout.html

Anyone better at front end design and development will be able to add to this ticket to explain how to make it work.

Ideally we should have some design input but I know we are already waiting on that for other tickets so perhaps we could mock this up in code and then add it to the queries we have for Design.

Suitable for help from anyone with front-end skills, no prior knowledge of Vizro is required, so I'm marking as "Help Wanted" and "Good First Issue"

@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 26, 2024
@stichbury
Copy link
Contributor Author

Note to add: We could also add another tab to point into the contribution documentation since this will be the same for all packages in the monorepo and will have one single source of docs (plus it's different kind of docs -- contributor content not user content -- so makes sense to separate it in the nav).

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