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: reference to a section that does not exist #1536

Closed
wants to merge 1 commit into from

Conversation

vsu727
Copy link

@vsu727 vsu727 commented Oct 11, 2024

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:

  • build: Changes that affect the build system or external dependencies (example scopes: yarn, eslint, typescript)
  • ci: Changes to our CI configuration files and scripts (example scopes: vercel, github, cypress)
  • docs: Documentation-only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: A code change that improves performance
  • refactor: A code change that doesn't fix a bug, or add a feature, or improves performance
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • test: Adding missing tests or correcting existing tests

Deployment tag versioning

Has tag in common/version.go been updated or have you added bump-version label to this PR?

  • No, this PR doesn't involve a new deployment, git tag, docker image tag
  • Yes

Breaking change label

Does this PR have the breaking-change label?

  • No, this PR is not a breaking change
  • Yes

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.

reference to a section that does not exist
2 participants