-
Notifications
You must be signed in to change notification settings - Fork 67
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
Changing navigation flow after Vcpkg installation (Windows installation) #59
Comments
@HarshCasper do you have any experience with changing the navigation flow in Sphinx docs? |
Shall I put up the flow of the videos and documentation under this issue itself? |
@Chicken-Biryani I think it would be better to have a dedicated issue for the work you are doing. As I suspect it will generate quite a bit of discussion 😅. Then we can link that issue to this one. Are you OK to open an issue for it? Let me know if you'd like some help with that. |
@sarahhaggarty Haha! Yes! That may be a long discussion. I'll open a new issue. |
After doing some googling it might not be possible to make this change using Sphinx but there has been a feature request created for it already: sphinx-doc/sphinx#9024. |
Unfortunately no 😞 |
What does the current documentation state?
For readers following the FLINT prerequisites instructions for a Windows installation, after they have completed the Vcpkg installation instructions on
vcpkg.rst
the Next button navigates the reader to the Linux installation instructionsdocker.rst
.Where is this stated?
On
vcpkg.rst
.Why do you want to improve the statement?
For a reader following Windows installation instructions it is confusing to proceed onto Linux installation instructions asking the reader to install Docker.
Proposed statement
Change the navigation flow so that instead of navigating to
docker.rst
it navigates to the FLINT Development Setup page (DevelopmentSetup\index.rst
).Additional info
This issue was found during discussion with @shubhamkarande13 and @Chicken-Biryani about #58
The text was updated successfully, but these errors were encountered: