docs: reference to a section that does not exist #1536
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
closes #1535
Purpose or design rationale of this PR
This pull request addresses two primary issues in the project’s documentation to enhance its accuracy and usability:
First is Fixing Reference to a Non-Existent Section:
Description of Changes:
Removed the "Note: ..." section from the Test section in coordinator/README.md. This block previously contained a link to a non-existent section Local Testing on M1/M2 Mac, resulting in broken links.
Deleted Broken Link: Removed the reference to the Local Testing on M1/M2 Mac section from the main README.md. This eliminates the issue of users encountering dead links, thereby improving the reliability of the documentation.
Motivation:
The existing "Note: ..." block contained a link to a section that does not exist in the main README.md, leading to broken links. This can confuse developers and hinder their ability to follow the documentation effectively. Removing these elements ensures that the documentation remains accurate and user-friendly.
Second is Correcting Errors in rollup/README.md:
Description of Changes:
Updated Number of Services: Changed the description in rollup/README.md from three essential rollup services to two essential rollup services, reflecting the actual number of services present in the cmd directory (gas_oracle and rollup_relayer).
Adjusted Number of Components: Modified the Rollup Relayer section in rollup/README.md to indicate that it consists of two components instead of three, aligning with the actual implementation.
Converted HTML Links to Markdown: Replaced HTML tags with Markdown link syntax in rollup/README.md for consistency and improved readability across the documentation.
Motivation
The original documentation incorrectly stated the number of services and components, leading to potential misunderstandings about the project’s architecture. Additionally, using consistent Markdown syntax for links enhances the overall readability and maintainability of the documentation.
PR title
Your PR title must follow conventional commits (as we are doing squash merge for each PR), so it must start with one of the following types:
Deployment tag versioning
Has
tag
incommon/version.go
been updated or have you addedbump-version
label to this PR?Breaking change label
Does this PR have the
breaking-change
label?