moja-global / moja-global/moja_global_docs
Changing navigation flow after Vcpkg installation (Windows installation)
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 35
- Forks
- 64
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/prerequisites/vcpkg.rst and inspect its navigation links. Update the Windows path so the Next button leads to docs/DevelopmentSetup/index.rst rather than docs/prerequisites/docker.rst, then build the documentation and verify the resulting navigation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100