Skip to content

General clean up of typos and list formatting #519

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

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

Conversation

eshaben
Copy link
Collaborator

@eshaben eshaben commented Jul 16, 2025

Description

This pull request focuses on improving the formatting and readability of documentation files by standardizing punctuation and enhancing clarity. The most significant updates include consistent use of colons for descriptions, bullet point formatting, and improved phrasing for better comprehension.

Checklist

  • Required - I have added a label to this PR 🏷️
  • Required - I have run my changes through Grammarly
  • If pages have been moved, I have created redirects in the wormhole-mkdocs repo

@eshaben eshaben added the A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) label Jul 16, 2025
@Copilot Copilot AI review requested due to automatic review settings July 16, 2025 05:41
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request focuses on improving the formatting and readability of documentation files by standardizing punctuation in lists and enhancing overall clarity. The key changes include converting simple bullet points to use colon-separated descriptions and ensuring consistent punctuation with periods throughout all documentation.

  • Standardizes bullet point formatting by converting dashes to colons for descriptions followed by periods
  • Updates table formatting for improved consistency and readability
  • Corrects minor typos and improves phrasing throughout documentation files

Reviewed Changes

Copilot reviewed 89 out of 98 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tools/typescript-sdk/sdk-reference.md Updates bullet point formatting to use colons and periods for Platform module descriptions
tools/typescript-sdk/guides/vaas-protocols.md Standardizes list formatting and corrects table alignment
tools/typescript-sdk/guides/sdk-layout.md Converts bullet points to colon format and adds consistent punctuation
tools/typescript-sdk/guides/protocols-payloads.md Updates list formatting throughout for protocol and payload descriptions
tools/typescript-sdk/get-started.md Standardizes prerequisite list formatting
tools/faqs.md Updates numbered list formatting for VAA submission steps
tools/dev-env.md Converts bullet points to colon format for development environment resources
tools/.solidity-sdk/.sdk-reference.md Updates list formatting for SDK considerations and module descriptions
tools/.solidity-sdk/.get-started.md Standardizes formatting for base contracts, interfaces, and prerequisites
protocol/security.md Updates bullet point formatting for Guardian security features
protocol/introduction.md Minor punctuation correction
protocol/infrastructure/vaas.md Extensive formatting updates for VAA structure descriptions and payload formats
protocol/infrastructure/spy.md Updates feature list formatting
protocol/infrastructure/relayer.md Standardizes relayer type descriptions and feature lists
protocol/infrastructure/guardians.md Updates Guardian principle descriptions
protocol/infrastructure/core-contracts.md Converts function descriptions to colon format
protocol/infrastructure-guides/run-relayer.md Updates prerequisite and step formatting
protocol/architecture.md Standardizes component descriptions
products/token-bridge/tutorials/transfer-workflow.md Updates prerequisite lists and step descriptions
products/token-bridge/tutorials/multichain-token.md Converts bullet points to numbered lists and standardizes formatting
products/token-bridge/portal/faqs.md Updates parameter table descriptions
products/token-bridge/overview.md Standardizes use case descriptions
products/token-bridge/guides/token-bridge-contracts.md Updates function parameter descriptions
products/token-bridge/get-started.md Standardizes prerequisite and next steps formatting
products/token-bridge/faqs.md Updates chain-specific descriptions
products/token-bridge/concepts/payload-structure.md Corrects field descriptions and summary table
products/settlement/overview.md Updates use case descriptions and minor text correction
products/settlement/get-started.md Standardizes script goal descriptions and prerequisites
products/settlement/concepts/architecture.md Updates protocol descriptions and step formatting
products/reference/wormhole-formatted-addresses.md Standardizes function descriptions
products/queries/reference/supported-methods.md Updates feature and finality level descriptions
products/queries/overview.md Standardizes use case descriptions
products/queries/guides/use-queries.md Updates step descriptions
products/queries/get-started.md Standardizes prerequisite and next steps formatting
products/queries/faqs.md Updates library descriptions
products/overview.md Standardizes solution descriptions
products/native-token-transfers/reference/managers-transceivers.md Updates function descriptions and rate limit formatting
products/native-token-transfers/reference/cli-commands.md Standardizes command table descriptions
products/native-token-transfers/overview.md Updates use case descriptions
products/native-token-transfers/guides/troubleshoot.md Standardizes troubleshooting point descriptions
products/native-token-transfers/guides/post-deployment.md Updates recommendation list formatting
products/native-token-transfers/guides/evm-launchpad.md Standardizes guide coverage and step descriptions
products/native-token-transfers/guides/deploy-to-solana.md Updates deployment step descriptions
products/native-token-transfers/guides/deploy-to-evm.md Standardizes parameter and command descriptions
products/native-token-transfers/get-started.md Updates prerequisite formatting and step descriptions

@eshaben eshaben requested a review from ilariae July 16, 2025 05:45
@eshaben eshaben added the B0 - Needs Review Pull request is ready for review label Jul 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A1 - Maintenance Major Pull request contains major updates to an existing page (i.e., adding a new section, reorgs, etc.) B0 - Needs Review Pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants