ansys / ansys-sphinx-theme

PyData-based Sphinx theme from the PyAnsys community
https://sphinxdocs.ansys.com
MIT License
21 stars 5 forks source link

Ansys Sphinx Theme - Design updates #403

Open mia-guo-ux opened 2 weeks ago

mia-guo-ux commented 2 weeks ago

Sphinx design : https://sphinxdocs.ansys.com/version/dev/examples/sphinx-design.html#

The following components could be enhanced to create a more streamlined user experience.

Please feel free to let me know if you have any concerns or if anything needs to be specified. Cheers! FYI @Revathyvenugopal162 @jorgepiloto @RobPasMue

mia-guo-ux commented 2 weeks ago

Card Home

mia-guo-ux commented 2 weeks ago

Buttons Buttons

mia-guo-ux commented 2 weeks ago

Links Links

mia-guo-ux commented 2 weeks ago

Side nav Side nav

mia-guo-ux commented 2 weeks ago

Select One thing is, the dropdown select component in Sphinx looks like an accordion component. image

Our proposed selector looks like this: Selector

mia-guo-ux commented 2 weeks ago

Dropdown Dropdown

mia-guo-ux commented 2 weeks ago

Table Table

mia-guo-ux commented 2 weeks ago

Scrollbar Scrollbar

mia-guo-ux commented 2 weeks ago

Breadcrumb Breadcrumb

mia-guo-ux commented 2 weeks ago

Tabs Tabs

mia-guo-ux commented 2 weeks ago

Generic guidelines Page

mia-guo-ux commented 2 weeks ago

Example pages PyAnsys Home2 Page

jorgepiloto commented 2 weeks ago

Thanks for this great review, @mia-guo-ux.

The only thing I do not agree is the text-align of the code blocks content. In my opinion, this should be left-aligned. Otherwise, we are loosing a precious space. Some statements can be quite long, so it is better to use all the available space. I am fine though adding some padding. What do you think?

RobPasMue commented 2 weeks ago

Thanks for this great review, @mia-guo-ux.

The only thing I do not agree is the text-align of the code blocks content. In my opinion, this should be left-aligned. Otherwise, we are loosing a precious space. Some statements can be quite long, so it is better to use all the available space. I am fine though adding some padding. What do you think?

I agree with Jorge - code-snippets should be left aligned IMO

mia-guo-ux commented 2 weeks ago

Great catch! Here's an updated screen. Besides this, please feel free to let me know if any of the updates is technically feasible and if any adjustment is needed :) Page

RobPasMue commented 1 week ago

Have we addressed all the changes @Revathyvenugopal162 @jorgepiloto ?

Revathyvenugopal162 commented 1 week ago

Have we addressed all the changes @Revathyvenugopal162 @jorgepiloto ?

We are addressing issues one by one. Thank you for notifying @RobPasMue, though it was mistakenly mentioned in the PR.

PipKat commented 1 week ago

Thanks for this great review, @mia-guo-ux. The only thing I do not agree is the text-align of the code blocks content. In my opinion, this should be left-aligned. Otherwise, we are loosing a precious space. Some statements can be quite long, so it is better to use all the available space. I am fine though adding some padding. What do you think?

I agree with Jorge - code-snippets should be left aligned IMO

Code blocks, captions, images, tables -- all should be left-aligned!

mia-guo-ux commented 1 week ago

The code snippet has been fixed. Please let me know if anything needs to be updated. :)

Revathyvenugopal162 commented 4 days ago

Table Table

PR #408

Changes made:

Revathyvenugopal162 commented 4 days ago

Generic guidelines Generic

PR #409

changes made:

Revathyvenugopal162 commented 4 days ago

Side nav Side nav

PR https://github.com/ansys/ansys-sphinx-theme/pull/411

Revathyvenugopal162 commented 4 days ago

Side nav Side nav

@mia-guo-ux , the color you mentioned for the active and hover states in the sidebar is the same, but it appears different in the image. Could you please clarify?

Revathyvenugopal162 commented 4 days ago

Links Links

@mia-guo-ux , For links, we have two additional states: visited links and visited hover links. Could you please check these and provide design suggestions for them as well?

mia-guo-ux commented 4 days ago

Side nav Side nav

@mia-guo-ux , the color you mentioned for the active and hover states in the sidebar is the same, but it appears different in the image. Could you please clarify?

Sorry for the confusion. The image has been updated. In Hover states, the bg fill is #ECECEC, but in Active states, it should be #D9D9D9

mia-guo-ux commented 4 days ago

Links Links

@mia-guo-ux , For links, we have two additional states: visited links and visited hover links. Could you please check these and provide design suggestions for them as well?

The design has been updated. Please see the image in the original post :)

mia-guo-ux commented 4 days ago

Hi @Revathyvenugopal162 I made a few updates to Tabs, Side nav, Links, and Global Nav. Please refer to the original post (the images have been re-uploaded). Thank you :)

In addition, here's the admonition component Admonitions

Revathyvenugopal162 commented 3 days ago

Links Links

PR #411

Revathyvenugopal162 commented 3 days ago

Task list