eiffel-community/eiffel-intelligence

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

オープン

#483 opened on 2020/11/17

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Java (78 件のフォーク)auto 404
buggood first issue

Repository metrics

Stars
 (12 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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

コントリビューターガイド