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

Broken links to pyansys dev guide in most of pyansys documentation. #267

Closed
Revathyvenugopal162 opened this issue Feb 27, 2023 · 3 comments · Fixed by #268
Closed

Broken links to pyansys dev guide in most of pyansys documentation. #267

Revathyvenugopal162 opened this issue Feb 27, 2023 · 3 comments · Fixed by #268
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Revathyvenugopal162
Copy link
Contributor

Revathyvenugopal162 commented Feb 27, 2023

Description of the modifications

In most of the pyansys docs, the link to developer guide is broken because of the new layout of the pyansys/actions. Examples:
https://dev.docs.pyansys.com/how-to/contributing.html should replace by https://dev.docs.pyansys.com/dev/how-to/contributing.html, in most of the contributing guide of respective docs.

One possible solution is Deploying the docs directly to gh pages, instead of dev folder, so use custom docs build rather than building with pyansys/actions. Redirection of main page will not work, for child pages.

Pinging here @jorgepiloto

Useful links and references

No response

@Revathyvenugopal162 Revathyvenugopal162 added the documentation Improvements or additions to documentation label Feb 27, 2023
@jorgepiloto
Copy link
Member

I agree. Knowing that our "dev-guide" is deployed everytime we merged something, multi-version does not make sense for this guide.

@jorgepiloto jorgepiloto self-assigned this Feb 27, 2023
@jorgepiloto
Copy link
Member

Let me address this issue. I want to take advantage to clean a bit the project.

@PipKat
Copy link
Member

PipKat commented Feb 27, 2023

On the documentation style page (https://dev.docs.pyansys.com/dev/doc-style/index.html), the link to MAPDL examples is broken. How should the URL look now that we want it to point to the stable version? I wanted to try out the "Edit this page" button but wasn't sure how to fix the broken URL. Also, at the bottom of this same page, there is a link to the "Documenting" page. When it is clicked, the nav pane on the right doesn't show the page title. I assume it's a font color issue?

image

Note that the new buttons for editing a page and showing the source for a page should be in sentence case. The "Edit a page" button is already in sentence case, but not the "Show Source" button. Could someone change it to "Show source"?

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

Successfully merging a pull request may close this issue.

3 participants