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

EI Pages in 2.0.0-maintainance branch point to documentation on the master #483

Open
SantoshNC68 opened this issue Nov 17, 2020 · 0 comments
Labels
bug Something is wrong and needs fixing. good first issue Good for newcomers.

Comments

@SantoshNC68
Copy link
Member

Description

Some of the documentation in 2.0.0-maintainance branch points out to the master branch which doesn't exist

Motivation

Updated documentation pointing out to proper branches and reachable documentation pages.

Exemplification

Here is an example of such page : https://github.com/eiffel-community/eiffel-intelligence/blob/2.0.0-maintenance/wiki/markdown/rules.md#Rule-set-up

Under the History Rules, when you click the here it points out to the master branch and that documentation is not available, instead it should point out to the 2.0.0-maintainance branch documentation itself.

Benefits

Readability of documentation and pointing out to the correct version of the documentation.

Possible Drawbacks

Unreachable pages and confusion to users on the documentation

@SantoshNC68 SantoshNC68 added bug Something is wrong and needs fixing. good first issue Good for newcomers. labels Nov 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is wrong and needs fixing. good first issue Good for newcomers.
Projects
None yet
Development

No branches or pull requests

1 participant