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

Issue: Incorrect and Broken Links in Documentation #7

Open
Viktordgbpcv opened this issue Aug 21, 2024 · 0 comments
Open

Issue: Incorrect and Broken Links in Documentation #7

Viktordgbpcv opened this issue Aug 21, 2024 · 0 comments

Comments

@Viktordgbpcv
Copy link

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

  • 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.
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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant