fractal-bitcoin / fractal

MIT License
65 stars 22 forks source link

Issue: Incorrect and Broken Links in Documentation #7

Open Viktordgbpcv opened 2 months ago

Viktordgbpcv commented 2 months ago

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:

  1. Some links point to pages that no longer exist or have been moved.
  2. There are spelling errors and inconsistencies in formatting within the documentation.
  3. Certain content needs updating to reflect the current state or features of the project.

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. image dd2bad0d-3089-491c-96d3-23e39adf7cc2

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.

image image

Issue3: First, click on multiprocess.md, then click on build-unix.mdbuild-osx.mdsrc/interfaces/conventionsC++ 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.

img_v3_02dv_440bbf37-ed68-4921-9389-1d9297b44a7g