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

docs: fix documentation broken links and enhance readability #8

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Viktordgbpcv
Copy link

Description:

This PR addresses multiple issues within the documentation of the fractal-bitcoin/fractal repository, including fixing broken links, correcting spelling errors, resolving formatting inconsistencies, and enhancing the overall readability of the documentation.

Changes Made:

  1. Updated all broken links to ensure they point to the correct pages.
  2. Corrected spelling errors and resolved formatting inconsistencies in the documentation.
  3. Enhanced Markdown formatting and readability in src/test/README.md.
  4. Improved Markdown formatting and readability in the main README document.

Testing:

  • Manually verified the validity of all updated links.
  • Ensured that the documentation displays correctly across different Markdown renderers.
  • Reviewed the enhanced formatting to confirm improved readability.

Impact:

These changes affect only the documentation and do not impact the code or functionality.

Related Issue: #7

@Viktordgbpcv Viktordgbpcv changed the title Fix Documentation Broken Links and Enhance Readability docs: fix documentation broken links and enhance readability Aug 21, 2024
@proteanx
Copy link

I would think it would be better to update the documentation to actually be for fractal rather than bitcoin core... but there's been virtually no activity from the fractal team on here anyways.

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

Successfully merging this pull request may close these issues.

2 participants