Skip to content

docs: fix typos, formatting, and broken links across docs and source#449

Open
ZLeventer wants to merge 1 commit into
salesforcecli:mainfrom
ZLeventer:fix/docs-typos-and-formatting
Open

docs: fix typos, formatting, and broken links across docs and source#449
ZLeventer wants to merge 1 commit into
salesforcecli:mainfrom
ZLeventer:fix/docs-typos-and-formatting

Conversation

@ZLeventer
Copy link
Copy Markdown

Summary

Fixes 20+ typos, grammar issues, formatting inconsistencies, and broken links across documentation and source files:

Typos

  • "gaurantee" → "guarantee" in 5 package READMEs
  • "Interal" → "Internal" in 2 package.json descriptions
  • "puproses" → "purposes" in EXAMPLE provider (2 files)
  • "truely" → "truly" in EXAMPLE provider test
  • "resole" → "resolve" in get_username tool description
  • "the the" → "the" in DEVELOPING.md

Formatting & grammar

  • Double period in aura-experts toolset description
  • Broken sentence in create_lwc_component_from_prd description ("structure. and")
  • Tool name mismatch: run_apex_tests (plural) in prose vs run_apex_test (singular) everywhere else
  • Missing (NON-GA) label on create_mobile_lwc_payments
  • Trailing space before ] in markdown link
  • Double space in sfDevopsListWorkItems tool description
  • Leading space in create_org_snapshot description param
  • Lowercase salesforceSalesforce in delete_org description
  • Garbled sentence in get_username tool description
  • Grammar fix in Dependabot section
  • "a MCP" → "an MCP" in code-analyzer package.json

Structural

  • Broken markdown link syntax in packages/mcp/DEVELOPING.md
  • Removed internal Confluence URL from public EXAMPLE provider

Test plan

  • All changes are in string literals, markdown, and package.json descriptions — no logic changes
  • yarn build should pass unchanged
  • Verify rendered markdown in GitHub preview

- Fix "gaurantee" → "guarantee" in 5 package READMEs
- Fix "Interal" → "Internal" in 2 package.json descriptions
- Fix "puproses" → "purposes" in EXAMPLE provider source
- Fix "truely" → "truly" in EXAMPLE provider test
- Fix "resole" → "resolve" in get_username tool description
- Fix "the the" → "the" and grammar in DEVELOPING.md
- Fix double period in aura-experts toolset description
- Fix broken sentence in create_lwc_component_from_prd description
- Fix tool name mismatch: run_apex_tests → run_apex_test in README prose
- Add missing (NON-GA) label on create_mobile_lwc_payments
- Fix trailing space in markdown link syntax
- Fix broken markdown link in packages/mcp/DEVELOPING.md
- Fix double space in sfDevopsListWorkItems tool description
- Fix leading space in create_org_snapshot description param
- Capitalize "salesforce" → "Salesforce" in delete_org description
- Fix garbled sentence in get_username tool description
- Remove internal Confluence URL from public EXAMPLE provider
- Fix "a MCP" → "an MCP" in code-analyzer package.json
@ZLeventer ZLeventer requested review from a team as code owners April 24, 2026 13:15
@salesforce-cla
Copy link
Copy Markdown

Thanks for the contribution! Before we can merge this, we need @ZLeventer to sign the Salesforce Inc. Contributor License Agreement.

@ZLeventer
Copy link
Copy Markdown
Author

Signed the CLA

@ZLeventer
Copy link
Copy Markdown
Author

@salesforce-cla recheck

@ZLeventer
Copy link
Copy Markdown
Author

I've signed the Salesforce CLA — recheck should pass now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant