In the fractal-bitcoin/fractal repository, several errors and broken links have been identified within the documentation. These issues can hinder users from accessing necessary information, thereby affecting user experience and development efficiency.
Details:
Some links point to pages that no longer exist or have been moved.
There are spelling errors and inconsistencies in formatting within the documentation.
Certain content needs updating to reflect the current state or features of the project.
Expected behavior
All links within the documentation should direct users to the correct and intended pages.
The documentation should be free of spelling errors and formatting inconsistencies.
Content should accurately reflect the current state and features of the project.
Actual behavior
Some links in the documentation are broken or lead to outdated pages.
There are noticeable spelling errors and inconsistent formatting throughout the documentation.
Certain sections of the documentation are outdated and do not accurately represent the current project features.
To reproduce
Issue 1: First, click on developer-notes.md, then click on Doxyfile.in. This will redirect you to a 404 page, as shown in the image.
Issue2:
First, click on developer-notes.md, then click on lint-locale-dependence.sh. This will redirect you to a 404 page, as shown in the image.
Issue3:
First, click on multiprocess.md, then click on build-unix.md、build-osx.md、src/interfaces/ 、conventions、C++ interface methods. There are 5 incorrect links in this file, and all of them will redirect you to a 404 page, as shown in the image.
Description:
In the
fractal-bitcoin/fractal
repository, several errors and broken links have been identified within the documentation. These issues can hinder users from accessing necessary information, thereby affecting user experience and development efficiency.Details:
Expected behavior
Actual behavior
To reproduce Issue 1: First, click on developer-notes.md, then click on
Doxyfile.in
. This will redirect you to a 404 page, as shown in the image.Issue2: First, click on developer-notes.md, then click on
lint-locale-dependence.sh
. This will redirect you to a 404 page, as shown in the image.Issue3: First, click on multiprocess.md, then click on
build-unix.md
、build-osx.md
、src/interfaces/
、conventions
、C++ interface methods
. There are 5 incorrect links in this file, and all of them will redirect you to a 404 page, as shown in the image.