Skip to content

docs: apply style guide conventions and fix trailing whitespace - #1979

Merged
stephentoub merged 1 commit into
github:mainfrom
rinceyuan:fix/docs-style-guide-cleanup
Jul 14, 2026
Merged

docs: apply style guide conventions and fix trailing whitespace#1979
stephentoub merged 1 commit into
github:mainfrom
rinceyuan:fix/docs-style-guide-cleanup

Conversation

@rinceyuan

Copy link
Copy Markdown
Contributor

Applies the repo's own docs style guide to documentation files:

Style guide word choice fixes

The style guide specifies:

Use Avoid
\ or example\ \e.g.\
\�nd similar\ \etc.\

Following existing docs convention (\�nd more\ is already used in \docs/README.md\ and \docs/auth/README.md\):

  • docs/auth/authenticate.md — 2 \etc.\ → \�nd more\
  • docs/features/cloud-sessions.md — 1 \e.g.\ → \For example\
  • docs/setup/choosing-a-setup-path.md — 1 \etc.\ → \�nd more\
  • docs/troubleshooting/mcp-debugging.md — 1 \etc.\ → \�nd more\

Trailing whitespace cleanup

  • docs/README.md — heading trailing space
  • docs/auth/authenticate.md — list item trailing spaces
  • docs/troubleshooting/mcp-debugging.md — checklist item trailing spaces

No files that conflict with open PRs were modified.

Apply the docs style guide (.github/instructions/docs-style.instructions.md):
- Replace 'etc.' with 'and more' (4 occurrences across 3 files)
- Replace 'e.g.' with 'For example' (1 occurrence in code comment)
- Remove trailing whitespace (3 occurrences across 3 files)

Only safe files with no open PR conflicts were modified.
@rinceyuan
rinceyuan requested a review from a team as a code owner July 14, 2026 08:03
@rinceyuan

Copy link
Copy Markdown
Contributor Author

@microsoft-github-policy-service agree company=Microsoft

@rinceyuan

Copy link
Copy Markdown
Contributor Author

@scottaddie Quick style guide compliance fix — replacing \etc.\ and \e.g.\ per the repo's docs style guide, plus minor trailing whitespace cleanup. Only touched files with no open PR conflicts. Thanks!

@stephentoub stephentoub left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks

@stephentoub
stephentoub added this pull request to the merge queue Jul 14, 2026
Merged via the queue into github:main with commit 584a239 Jul 14, 2026
edburns pushed a commit to edburns/copilot-sdk that referenced this pull request Jul 14, 2026
…ub#1979)

Apply the docs style guide (.github/instructions/docs-style.instructions.md):
- Replace 'etc.' with 'and more' (4 occurrences across 3 files)
- Replace 'e.g.' with 'For example' (1 occurrence in code comment)
- Remove trailing whitespace (3 occurrences across 3 files)

Only safe files with no open PR conflicts were modified.

Co-authored-by: j-zhangyiyuan <j-zhangyiyuan@microsoft.com>
edburns pushed a commit that referenced this pull request Aug 4, 2026
Apply the docs style guide (.github/instructions/docs-style.instructions.md):
- Replace 'etc.' with 'and more' (4 occurrences across 3 files)
- Replace 'e.g.' with 'For example' (1 occurrence in code comment)
- Remove trailing whitespace (3 occurrences across 3 files)

Only safe files with no open PR conflicts were modified.

Co-authored-by: j-zhangyiyuan <j-zhangyiyuan@microsoft.com>
edburns pushed a commit that referenced this pull request Aug 4, 2026
Apply the docs style guide (.github/instructions/docs-style.instructions.md):
- Replace 'etc.' with 'and more' (4 occurrences across 3 files)
- Replace 'e.g.' with 'For example' (1 occurrence in code comment)
- Remove trailing whitespace (3 occurrences across 3 files)

Only safe files with no open PR conflicts were modified.

Co-authored-by: j-zhangyiyuan <j-zhangyiyuan@microsoft.com>
@rinceyuan
rinceyuan deleted the fix/docs-style-guide-cleanup branch August 7, 2026 02:02
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.

2 participants