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

Changing navigation flow after Vcpkg installation (Windows installation) #59

Open
sarahhaggarty opened this issue Jul 28, 2021 · 6 comments

Comments

@sarahhaggarty
Copy link
Contributor

sarahhaggarty commented Jul 28, 2021

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 instructions docker.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

@sarahhaggarty
Copy link
Contributor Author

@HarshCasper do you have any experience with changing the navigation flow in Sphinx docs?

@shloka-gupta
Copy link
Member

Shall I put up the flow of the videos and documentation under this issue itself?

@sarahhaggarty @shubhamkarande13

@sarahhaggarty
Copy link
Contributor Author

@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.

@shloka-gupta
Copy link
Member

shloka-gupta commented Jul 28, 2021

@sarahhaggarty Haha! Yes! That may be a long discussion.

I'll open a new issue.

@sarahhaggarty
Copy link
Contributor Author

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.

@HarshCasper
Copy link
Member

@HarshCasper do you have any experience with changing the navigation flow in Sphinx docs?

Unfortunately no 😞

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

No branches or pull requests

3 participants