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

Include an announcement banner to inform users about the default redirection being set to the 'version/dev' path #423

Open
Revathyvenugopal162 opened this issue Nov 22, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation

Comments

@Revathyvenugopal162
Copy link
Contributor

Description of the modifications

The banner conveys information regarding the default redirect path, now set to 'version/dev.' the banner can be reuse from pydata or we can write own own banner.

Useful links and references

https://pydata-sphinx-theme.readthedocs.io/en/latest/index.html

@Revathyvenugopal162 Revathyvenugopal162 added the documentation Improvements or additions to documentation label Nov 22, 2023
@RobPasMue
Copy link
Member

We need to clarify what is it we want to inform users about with this banner - because I still don't get it.

@RobPasMue
Copy link
Member

We want to inform them that they are being redirected to the "dev" version? Most people expect these docs to be a general landing page rather than a Python package landing page. Following that thought... I think the banner would introduce more confusion rather than clarity.

@Revathyvenugopal162
Copy link
Contributor Author

We want to inform them that they are being redirected to the "dev" version? Most people expect these docs to be a general landing page rather than a Python package landing page. Following that thought... I think the banner would introduce more confusion rather than clarity.

i mean the other way as well, Users are required to manually identify their installed pyansys version from a dropdown menu rather than having a direct match with the landing page version of corresponding library or they have to upgrade their library.

@RobPasMue
Copy link
Member

I think I am not following you @Revathyvenugopal162...

Do you want to inform users that have installed the pyansys metapackage, that they should switch to their specific installed version (using the switcher) to have access to the docs of the dependencies (i.e. different PyAnsys packages) installed?

@Revathyvenugopal162
Copy link
Contributor Author

I think I am not following you @Revathyvenugopal162...

Do you want to inform users that have installed the pyansys metapackage, that they should switch to their specific installed version (using the switcher) to have access to the docs of the dependencies (i.e. different PyAnsys packages) installed?

Yeah something similar. it is a just a suggestion If you find it unrelated, we can disregard.

@RobPasMue
Copy link
Member

Let's do the following. Propose a PR with your suggestion. We can iterate on it 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants