Recommended fixes for specs/interop/messaging.md and specs/interop/predeploys.md #527
+25
−16
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.
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.
specs/interop/messaging.md
:specs/interop/predeploys.md
:createOptimismMintableERC20
orcreateStandardL2Token
".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.Tests
Additional Context
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.