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

Doc/#1007 improve navigability #1105

Merged
merged 40 commits into from
Sep 6, 2024
Merged

Conversation

FlorianJacta
Copy link
Member

@FlorianJacta FlorianJacta commented Aug 30, 2024

Resolves: #1007

You can see the POC for this PR here: https://docs.taipy.io/en/doc-add-sections-and-quick-access/ (the links are not correct, and the section on visual elements is different; in this PR (1105), all visual elements are listed without putting them into groups, I propose to do that in a second time)

What is done:

  • Quick access in html and CSS for quick access
  • '/' in search bar
  • Top header erased
  • Boost Viz elements
  • Automatic generation of Viz elements doc
  • CSS for navbar highlight
  • Refactor manuals to user manual

Needs to be done:

  • Categorized viz elements in Controls, SM controls, and blocks
  • Where to put Releases Notes and Contributing

@FlorianJacta FlorianJacta self-assigned this Aug 30, 2024
@FlorianJacta FlorianJacta marked this pull request as draft August 30, 2024 09:18
@FlorianJacta FlorianJacta added 📄 Documentation Internal or public documentation 🟧 Priority: High Stalls work on the project or its dependents labels Sep 3, 2024
@FlorianJacta FlorianJacta marked this pull request as ready for review September 3, 2024 14:54
@RymMichaut
Copy link
Member

Hey Flo,
Nice job.

Can we add a 〉at the beginning of the charts to show that it's a drop-down menu (like in Tutorials)? It feels like the menu level is not the same without it. It would standardize the navigation.
image

  • And when dropping down the "charts", can we indent its drop-down menu?
    image

  • The new charter has a new palette: #ff371a #0b0b0e #55c1f6 #ffffff. We may use the same

@FlorianJacta
Copy link
Member Author

Thank your @RymMichaut !

Can we add a 〉at the beginning of the charts to show that it's a drop-down menu (like in Tutorials)? It feels like the menu level is not the same without it. It would standardize the navigation.

True! In the current PR (not the view you are seeing), there is no arrow at all; you cannot expand the chart section. This will come later as the code is a bit hard to automate.

And when dropping down the "charts", can we indent its drop-down menu?

I'm not sure I understand this, but I think this will also be done with the next PR.

The new charter has a new palette: #ff371a #0b0b0e #55c1f6 #ffffff. We may use the same

That would be best, but this will come in another PR, too 😄 . This change impacts Taipy Doc and Taipy.

Copy link
Member

@jrobinAV jrobinAV left a comment

Choose a reason for hiding this comment

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

Much better.

@FlorianJacta FlorianJacta merged commit 656b9e6 into develop Sep 6, 2024
1 check passed
@jrobinAV jrobinAV deleted the doc/#1007-improve-navigability branch September 6, 2024 09:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📄 Documentation Internal or public documentation 🟧 Priority: High Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve doc navigability and UX
3 participants