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

Recommended fixes for specs/interop/messaging.md and specs/interop/predeploys.md #527

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

Conversation

Red-Pandaz
Copy link

Description

Pull Request Summary:

This PR includes proofreading and formatting updates to specs/interop/messaging.md and specs/interop/predeploys.md, along with configuration adjustments to two Mermaid diagrams for better accessibility.

  • File Changes:
    • specs/interop/messaging.md:

      • Clarified the sentence regarding raw log data by rephrasing it for better readability .
      • Corrected the phrase "initiating messages is" to "initiating messages have" for grammatical accuracy.
      • Added a comma after "I.e." for consistency with standard punctuation rules.
    • specs/interop/predeploys.md:

      • Changed "ie" to "i.e." by adding periods for proper abbreviation.
      • Added a comma before "but" for clarity and consistency.
      • Added "which is" for clarity and "also" to improve sentence flow.
      • Corrected phrasing by changing "equal to" to "be equal to" for grammatical accuracy.
      • Rephrased a sentence by changing "to" to "of" for better clarity and accuracy.
      • Corrected a sentence by changing "include" to "includes" for subject-verb agreement.
      • Corrected a sentence by changing "are" to "is" to ensure subject-verb agreement when referring to "either createOptimismMintableERC20 or createStandardL2Token".
      • Adjusted configurations for Mermaid graphs to dark mode and increased font size for better readability and accessibility.
        • Set fontSize to 28 for the first diagram and 48 for the second. The font sizing does not scale up for the second as it does for the first, possibly due to the diagram being more cluttered. The diagram with 48px actually displays a smaller font size. This can be revisited but for now it dramatically improves the accessibility of both diagrams.
      • Removed the extra backtick at the end of a sentence for proper formatting.

Tests

  • No new tests were added as part of this PR, as the changes are primarily focused on documentation, clarity, and visual accessibility improvements. All changes were reviewed for consistency, and no functional behavior was altered. The Mermaid configuration and grammar fixes do not impact existing functionality, so no new tests are required at this time.

Additional Context

  • The changes to the Mermaid diagrams (font size and theme) are aimed at improving the visual accessibility for readers. The fontSize adjustments were made to ensure that the diagrams are more legible, especially for users with visual impairments. Although the second diagram did not scale as expected, it still provides a significant improvement over the previous font size. Further adjustments may be needed for more complex diagrams with large amounts of content, but this change is a step toward improving accessibility.

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.

1 participant